implement the november batch of unified github workflows improvements (ipdxco#100)

galargh · web-flow · commit c48281621dbc · 2024-12-04T21:00:02.000+01:00
* chore(ipdxco#69): do not install go twice when not needed * feat(ipdxco#91): simplify disabling CGO for the Go tests * fix(ipdxco#89): do not release -dev/-rc versions as latest * chore(ipdxco#86): mark go updating PRs as breaking changes * chore(ipdxco#70): remove usage of search api from releaser workflow * fix: the second go setup conditional in go-test * fix: the second go setup conditional in go-check * fix: the second go setup conditional in go-test * fix: the cgo enabled config key retrieval * fix: finding merge pr in releaser * fix: finding merge pr in releaser
diff --git a/.github/workflows/go-check.yml b/.github/workflows/go-check.yml
@@ -23,6 +23,7 @@ jobs:
         with:
           submodules: recursive
       - name: Check out the latest stable version of Go
+        id: stable
         uses: actions/setup-go@v5
         with:
           go-version: stable
@@ -35,6 +36,7 @@ jobs:
         uses: ipdxco/unified-github-workflows/.github/actions/read-go-mod@main
       - name: Set up the Go version read from the go.mod file
         id: go
+        if: (inputs.go-version || fromJSON(steps.go-mod.outputs.json).Go) != steps.stable.outputs.go-version || inputs.go-cache != 'false'
         uses: actions/setup-go@v5
         with:
           go-version: ${{ inputs.go-version || fromJSON(steps.go-mod.outputs.json).Go }}
diff --git a/.github/workflows/go-test.yml b/.github/workflows/go-test.yml
@@ -44,6 +44,7 @@ jobs:
         with:
           submodules: recursive
       - name: Check out the latest stable version of Go
+        id: stable
         uses: actions/setup-go@v5
         with:
           go-version: stable
@@ -94,6 +95,7 @@ jobs:
           echo "GORACEFLAGS=-v $GORACEFLAGS" >> $GITHUB_ENV
       - name: Set up the Go version read from the go.mod file
         uses: actions/setup-go@v5
+        if: steps.go.outputs.version != steps.stable.outputs.go-version || inputs.go-cache != 'false'
         with:
           go-version: ${{ steps.go.outputs.version }}
           cache: ${{ inputs.go-cache }}
@@ -109,6 +111,7 @@ jobs:
         uses: protocol/multiple-go-modules@v1.4
         env:
           GOFLAGS: ${{ format('{0} {1}', env.GOTESTFLAGS, env.GOFLAGS) }}
+          CGO_ENABLED: ${{ toJSON(fromJSON(steps.config.outputs.json).cgo) != 'false' }}
         with:
           run: go test ./...
       - name: Run tests (32 bit)
@@ -120,6 +123,7 @@ jobs:
         env:
           GOARCH: 386
           GOFLAGS: ${{ format('{0} {1}', env.GO386FLAGS, env.GOFLAGS) }}
+          CGO_ENABLED: ${{ toJSON(fromJSON(steps.config.outputs.json).cgo) != 'false' }}
         with:
           run: |
             export "PATH=$PATH_386:$PATH"
@@ -132,6 +136,7 @@ jobs:
         uses: protocol/multiple-go-modules@v1.4
         env:
           GOFLAGS: ${{ format('{0} {1}', env.GORACEFLAGS, env.GOFLAGS) }}
+          CGO_ENABLED: ${{ toJSON(fromJSON(steps.config.outputs.json).cgo) != 'false' }}
         with:
           run: go test -race ./...
       - name: Collect coverage files
diff --git a/.github/workflows/releaser.yml b/.github/workflows/releaser.yml
@@ -61,6 +61,7 @@ jobs:
           done
           echo "version=$version" | tee -a $GITHUB_OUTPUT
           echo "tag=${prefix}${version}" | tee -a $GITHUB_OUTPUT
+          echo "suffix=${version#*[-+]}" | tee -a $GITHUB_OUTPUT
       - id: latest
         if: steps.version.outputs.version != ''
         name: Determine latest version
@@ -94,30 +95,29 @@ jobs:
         env:
           GITHUB_TOKEN: ${{ github.token }}
           REPOSITORY: ${{ github.repository }}
-          QUERY: repository:${{ github.repository }} is:pr is:merged ${{ github.sha }}
+          REF: ${{ github.ref }}
           SHA: ${{ github.sha }}
         uses: actions/github-script@v7
         with:
           script: |
             const [owner, repo] = process.env.REPOSITORY.split('/');
-            const items = await github.paginate(github.rest.search.issuesAndPullRequests, {
-              q: process.env.QUERY,
+            const ref = process.env.REF.replace(/^refs\/heads\//, '');
+            const candidates = await github.paginate(github.rest.pulls.list, {
+              owner,
+              repo,
+              state: 'closed',
+              base: ref,
             });
             let pr;
-            for (const item of items) {
-              const candidate = await github.rest.pulls.get({
-                owner,
-                repo,
-                pull_number: item.number,
-              });
-              if (candidate.data.merge_commit_sha === process.env.SHA) {
+            for (const candidate of candidates) {
+              if (candidate.merge_commit_sha === process.env.SHA) {
                 pr = candidate;
                 break;
               }
             }
             if (pr !== undefined) {
-              console.log(`Found PR: ${pr.data.html_url}`);
-              const labels = pr.data.labels.map(l => l.name);
+              console.log(`Found PR: ${pr.html_url}`);
+              const labels = pr.labels.map(l => l.name);
               const release = labels.includes('release');
               console.log(`This is a release PR: ${release}`);
               core.setOutput('release', release);
@@ -148,7 +148,7 @@ jobs:
           tag_name: ${{ steps.version.outputs.tag }}
           generate_release_notes: true
           target_commitish: ${{ github.sha }}
-          make_latest: ${{ steps.version.outputs.prefix == 'v' && steps.version.outputs.tag == steps.latest.outputs.latest }}
+          make_latest: ${{ steps.version.outputs.prefix == 'v' && steps.version.outputs.suffix == '' && steps.version.outputs.tag == steps.latest.outputs.latest }}
           token: ${{ secrets.UCI_GITHUB_TOKEN || github.token }}
       - name: Create release.json
         if: steps.release.outputs.id != ''
@@ -163,7 +163,7 @@ jobs:
               "id": "${{ steps.release.outputs.id }}",
               "upload_url": "${{ steps.release.outputs.upload_url }}",
               "assets": ${{ steps.release.outputs.assets }},
-              "make_latest": ${{ steps.version.outputs.prefix == 'v' && steps.version.outputs.tag == steps.latest.outputs.latest }},
+              "make_latest": ${{ steps.version.outputs.prefix == 'v' && steps.version.outputs.suffix == '' && steps.version.outputs.tag == steps.latest.outputs.latest }},
               "source": "${{ matrix.source }}"
             }
         run: |
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -5,6 +5,16 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
 ## Unreleased
+### Added
+- a `cgo` job specific configuration variable which disables cgo in the go-test workflow
+
+### Changed
+- do not install the same version of Go twice in the go-test and go-check workflows
+- mark the Go update commits as breaking changes in the style of conventional commits
+- removed usage of search API from the releaser workflow
+
+### Fixed
+- do not mark prereleases or versions with build strings as latest in the releaser workflow
 
 ## [1.0.15] - 2024-11-28
 ### Changed
diff --git a/README.md b/README.md
@@ -113,6 +113,13 @@ If you want to disable verbose logging or test shuffling, you can do so by setti
 }
 ```
 
+If you want to disable cgo, you can do so by setting `cgo` to `false` in `.github/workflows/go-test-config.json`:
+```json
+{
+  "cgo": false
+}
+```
+
 ### Workflow Modification
 
 You can modify the workflows distributed by Unified CI as you wish. Unified CI will only ever try to update the versions of reusables after the initial distribution. Similarly to how dependabot operates.
diff --git a/scripts/update-go.sh b/scripts/update-go.sh
@@ -55,7 +55,7 @@ while read file; do
   git add .
 
   if ! git diff-index --quiet HEAD; then
-    git commit -m "chore: bump go.mod to Go $expected and run go fix"
+    git commit -m "chore!: bump go.mod to Go $expected and run go fix" -m "BREAKING CHANGE: Updating the Go version to $expected"
   fi
 
   if [[ -f go.work ]]; then
@@ -64,7 +64,7 @@ while read file; do
     go work use
     git add .
     if ! git diff-index --quiet HEAD; then
-      git commit -m "chore: bump go.work to Go $expected"
+      git commit -m "chore!: bump go.work to Go $expected" -m "BREAKING CHANGE: Updating the Go version to $expected"
     fi
   fi
 
