Merge pull request #352 from dafyddj/ci/sem-rel-dry-run

ci: move towards releasing using GitHub Actions

Author: dafyddj

.github/workflows/main.yml

@@ -98,10 +98,17 @@ jobs:
   results:
     name: Release / Collect results
     permissions:
+      contents: write
+      issues: write
+      pull-requests: write
       checks: read
+    container: techneg/ci-semantic-release:v1.1.0
     runs-on: ubuntu-latest
     timeout-minutes: 15
     steps:
+      - run: |  # Needed due to bug actions/checkout#2031
+          git config --global --add safe.directory "$GITHUB_WORKSPACE"
+      - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
       # yamllint disable-line rule:line-length
       - uses: poseidon/wait-for-status-checks@899c768d191b56eef585c18f8558da19e1f3e707 # v0.6.0
         with:
@@ -114,4 +121,10 @@ jobs:
             Test / Kitchen (ubuntu-2004-master)
           ignore_pattern: ^GitLab CI
           token: ${{ secrets.GITHUB_TOKEN }}
+      - name: Run `semantic-release`
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          MAINTAINER_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        run: |
+          semantic-release --dry-run
       - run: echo "::notice ::Workflow success!"

.gitlab-ci.yml

@@ -20,7 +20,7 @@
   image_dindrubybionic: &image_dindrubybionic 'techneg/ci-docker-python-ruby:v2.2.67@sha256:2887fb02ee694a97241777b043b1942b7e6803080e06dd18633f083eed463844'
   image_precommit: &image_precommit 'techneg/ci-pre-commit:v2.4.32@sha256:fa9eef397583add95f4fccefa6ecbbf7a3845d6168f07393da7bc619696b246b'
   image_rubocop: &image_rubocop 'pipelinecomponents/rubocop:latest@sha256:fe69f9642c7edde46bbd78326d2c42c6e13fc73694efb142e92e206725479328'
-  image_semantic-release: &image_semanticrelease 'myii/ssf-semantic-release:15.14@sha256:374f588420087517a3cc0235e11293bffd72d7a59da3d98d5e69f014ff2a7761'
+  image_semantic-release: &image_semanticrelease 'techneg/ci-semantic-release:v1.1.0'
   # `services`
   services_docker_dind: &services_docker_dind
     - 'docker:28.3.2-dind@sha256:44383404ebf0c36243f5969f0dddd23c204ea3bb185e7473a4141f6ccfd07b53'
@@ -273,13 +273,10 @@ ubuntu-2004-3006-14: {extends: '.test_instance'}
 # `release` stage: `semantic-release`
 ###############################################################################
 semantic-release:
-  only: *only_branch_master_parent_repo
   stage: *stage_release
   image: *image_semanticrelease
   variables:
     MAINTAINER_TOKEN: '${GH_TOKEN}'
   script:
-    # Update `AUTHORS.md`
-    - '${HOME}/go/bin/maintainer contributor'
     # Run `semantic-release`
     - 'semantic-release'

pre-commit_semantic-release.sh

@@ -3,20 +3,24 @@
 ###############################################################################
 # (A) Update `FORMULA` with `${nextRelease.version}`
 ###############################################################################
+
 sed -i -e "s_^\(version:\).*_\1 ${1}_" FORMULA
 
 
 ###############################################################################
-# (B) Use `m2r2` to convert automatically produced `.md` docs to `.rst`
+# (B) Update `AUTHORS.md`
 ###############################################################################
 
-# Install `m2r2`
-pip3 install m2r2
+maintainer contributor --ignore-contributors semantic-release-bot,renovate[bot]
+
+###############################################################################
+# (C) Use `m2r` to convert automatically produced `.md` docs to `.rst`
+###############################################################################
 
 # Copy and then convert the `.md` docs
 cp ./*.md docs/
 cd docs/ || exit
-m2r2 --overwrite ./*.md
+m2r --overwrite ./*.md
 
 # Change excess `H1` headings to `H2` in converted `CHANGELOG.rst`
 sed -i -e '/^=.*$/s/=/-/g' CHANGELOG.rst

release.config.js

@@ -1,5 +1,5 @@
 module.exports = {
-  branch: 'master',
+  // TODO: remove this when we no longer process releases on GitLab CI
   repositoryUrl: 'https://github.com/saltstack-formulas/template-formula',
   plugins: [
     ['@semantic-release/commit-analyzer', {
@@ -21,88 +21,6 @@ module.exports = {
     '@semantic-release/github'
   ],
   generateNotes: {
-    preset: 'angular',
-    writerOpts: {
-      // Required due to upstream bug preventing all types being displayed.
-      // Bug: https://github.com/conventional-changelog/conventional-changelog/issues/317
-      // Fix: https://github.com/conventional-changelog/conventional-changelog/pull/410
-      transform: (commit, context) => {
-        const issues = []
-
-        commit.notes.forEach(note => {
-          note.title = 'BREAKING CHANGES'
-        })
-
-        // NOTE: Any changes here must be reflected in `CONTRIBUTING.md`.
-        if (commit.type === 'feat') {
-          commit.type = 'Features'
-        } else if (commit.type === 'fix') {
-          commit.type = 'Bug Fixes'
-        } else if (commit.type === 'perf') {
-          commit.type = 'Performance Improvements'
-        } else if (commit.type === 'revert') {
-          commit.type = 'Reverts'
-        } else if (commit.type === 'docs') {
-          commit.type = 'Documentation'
-        } else if (commit.type === 'style') {
-          commit.type = 'Styles'
-        } else if (commit.type === 'refactor') {
-          commit.type = 'Code Refactoring'
-        } else if (commit.type === 'test') {
-          commit.type = 'Tests'
-        } else if (commit.type === 'build') {
-          commit.type = 'Build System'
-          // } else if (commit.type === `chore`) {
-          //     commit.type = `Maintenance`
-        } else if (commit.type === 'ci') {
-          commit.type = 'Continuous Integration'
-        } else {
-          return
-        }
-
-        if (commit.scope === '*') {
-          commit.scope = ''
-        }
-
-        if (typeof commit.hash === 'string') {
-          commit.shortHash = commit.hash.substring(0, 7)
-        }
-
-        if (typeof commit.subject === 'string') {
-          let url = context.repository
-            ? `${context.host}/${context.owner}/${context.repository}`
-            : context.repoUrl
-          if (url) {
-            url = `${url}/issues/`
-            // Issue URLs.
-            commit.subject = commit.subject.replace(/#([0-9]+)/g, (_, issue) => {
-              issues.push(issue)
-              return `[#${issue}](${url}${issue})`
-            })
-          }
-          if (context.host) {
-            // User URLs.
-            commit.subject = commit.subject.replace(/\B@([a-z0-9](?:-?[a-z0-9/]){0,38})/g, (_, username) => {
-              if (username.includes('/')) {
-                return `@${username}`
-              }
-
-              return `[@${username}](${context.host}/${username})`
-            })
-          }
-        }
-
-        // remove references that already appear in the subject
-        commit.references = commit.references.filter(reference => {
-          if (issues.indexOf(reference.issue) === -1) {
-            return true
-          }
-
-          return false
-        })
-
-        return commit
-      }
-    }
+    preset: 'angular'
   }
 }