Merge pull request #128 from adamkpickering/simplify-repo-tooling

Simplify `charts-build-scripts` tooling

Author: adamkpickering

.dockerignore

@@ -1,36 +1,40 @@
-name: Pull-Request
+name: Lint and Test Build
 
 on:
   pull_request:
 
 jobs:
-  build:
+  test:
     runs-on: ubuntu-latest
-    container: 
-      image: rancher/dapper:v0.5.4
     steps:
-      - uses: actions/checkout@v1
-      - name: Run CI
-        run: dapper ci
+      - uses: actions/checkout@v4
+
+      - uses: actions/setup-go@v4
+        with:
+          go-version: '1.22'
 
-  build-validate:
+      - name: Run unit tests
+        run: go test ./...
+
+  lint:
     runs-on: ubuntu-latest
     steps:
-    - name: Checkout 
-      uses: actions/checkout@v3
+      - uses: actions/checkout@v4
+
+      - uses: golangci/golangci-lint-action@v4
+        with:
+          version: v1.57
 
-    - name: Build binaries
-      env:
-        CROSS: false
-      run: make build
+  build:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v4
 
-    - name: Checkout charts Repo
-      uses: actions/checkout@v3
+    - uses: actions/setup-go@v4
       with:
-        repository: rancher/charts
-        path: charts
+        go-version: '1.22'
 
-    - name: Run Validation
-      run: |
-        cd charts
-        ../bin/charts-build-scripts validate
+    - name: Run goreleaser
+      uses: goreleaser/goreleaser-action@v5
+      with:
+        args: build --snapshot

.github/workflows/label-all-new-issues.yml

@@ -1,43 +1,28 @@
+name: Make a Release
+
 on: 
-  release:
-    types: [created]
+  push:
+    tags:
+      - 'v*'
+
+permissions:
+  contents: write
 
 jobs:
-  build-assets:
+  goreleaser:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v2
-      - name: Build binaries
-        env:
-          CROSS: true
-        run: make build
-      - name: Get release
-        id: get_release
-        uses: bruceadams/[email protected]
-        env:
-          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-      - uses: actions/upload-release-asset@v1
-        env:
-          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+      - uses: actions/checkout@v4
         with:
-          upload_url: ${{ steps.get_release.outputs.upload_url }}
-          asset_path: bin/charts-build-scripts
-          asset_name: charts-build-scripts
-          asset_content_type: application/octet-stream
-      - uses: actions/upload-release-asset@v1
-        env:
-          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          fetch-depth: 0
+
+      - uses: actions/setup-go@v4
         with:
-          upload_url: ${{ steps.get_release.outputs.upload_url }}
-          asset_path: bin/charts-build-scripts-darwin
-          asset_name: charts-build-scripts-darwin
-          asset_content_type: application/octet-stream
-      - uses: actions/upload-release-asset@v1
+          go-version: '1.22'
+
+      - name: Run goreleaser
+        uses: goreleaser/goreleaser-action@v5
+        with:
+          args: release
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-        with:
-          upload_url: ${{ steps.get_release.outputs.upload_url }}
-          asset_path: bin/charts-build-scripts-windows
-          asset_name: charts-build-scripts-windows
-          asset_content_type: application/octet-stream
-

.github/workflows/pull-request.yaml

@@ -8,4 +8,5 @@ charts-build-scripts
 .DS_Store
 pkg/.DS_Store
 templates/.DS_Store
-.vscode
+.vscode
+dist/

.github/workflows/release.yaml

@@ -0,0 +1,35 @@
+version: 1
+
+project_name: charts-build-scripts
+
+before:
+  hooks:
+    - go mod tidy
+
+builds:
+  - env:
+      - CGO_ENABLED=0
+    goos:
+      - linux
+      - windows
+      - darwin
+    goarch:
+      - amd64
+      - arm
+      - arm64
+    ldflags:
+      - -X main.Version={{.Version}} -X main.GitCommit={{.ShortCommit}}
+
+archives:
+  - format: binary
+    name_template: '{{ .ProjectName }}_{{ .Os }}_{{ .Arch }}'
+
+checksum:
+  name_template: checksums.txt
+
+changelog:
+  sort: asc
+  filters:
+    exclude:
+      - "^docs:"
+      - "^test:"

.gitignore

@@ -1,11 +1,8 @@
-charts-build-scripts
-========
+# charts-build-scripts
 
-## Build Scripts For Rancher Charts
+## How to Use `charts-build-scripts`
 
-## Before running the scripts
-
-#### If you are creating a new charts repository 
+### Charts Repository Setup
 
 Checkout the Git branch that corresponds to your Staging or Live branch.
 
@@ -15,24 +12,67 @@ Export BRANCH_ROLE as `staging`, `live`, or `custom`. Then run:
 curl -s https://raw.githubusercontent.com/rancher/charts-build-scripts/master/init.sh > /dev/null | sh
 ```
 
-## Building
+### Building
 
 `make`
 
-## Running
+### Running
 
 `./bin/charts-build-scripts`
 
-## Validation command
+### Validation command
 
 For more information on the validation command, please see [`docs/validate.md`](docs/validate.md).
 
-## Debugging
+### Debugging
 
 For more information on how to debug this project, please see [`docs/debugging.md`](docs/debugging.md).
 
+
+## Developing `charts-build-scripts`
+
+### How to Run
+
+```
+go run main.go
+```
+
+### How to Run Unit Tests
+
+```
+go test ./...
+```
+
+### How to Lint
+
+```
+golangci-lint run ./...
+```
+
+### How to Release
+
+Releases are done via a github action that uses [`goreleaser`](https://goreleaser.com/).
+In order to release, simply tag the commit that you want the release
+to be based off of with a tag that is in semver format. For example:
+```
+git tag v0.1.9
+```
+Then, push that tag to the the rancher/charts-build-scripts repo.
+Here is an example, assuming that rancher/charts-build-scripts is
+configured as `upstream` in your local repo:
+```
+git push upstream --tags
+```
+Pushing the tag will trigger a github actions workflow that will use
+the `goreleaser` action to build binaries for many different combinations
+of OS and processor architecture. This same `goreleaser` action will
+then create a release using these binaries. Release notes will be
+constructed from commit messages.
+
+
 ## License
-Copyright (c) 2019 [Rancher Labs, Inc.](http://rancher.com)
+
+Copyright (c) 2024 [Rancher Labs, Inc.](http://rancher.com)
 
 Licensed under the Apache License, Version 2.0 (the "License");
 you may not use this file except in compliance with the License.