feat!: deploy creates a PR, and merging it will create a release

Author: kiyoon

.github/workflows/auto-release.yml

@@ -0,0 +1,62 @@
+name: Auto-release following a release commit
+
+on:
+  push:
+    branches:
+      - main
+      - master
+    paths:
+      - 'docs/CHANGELOG.md'
+
+jobs:
+  release:
+    runs-on: ubuntu-latest
+    outputs:
+      RELEASE_VERSION: ${{ steps.parse_commit.outputs.RELEASE_VERSION }}
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+
+      - name: Parse commit message to get version
+        id: parse_commit
+        run: |
+          # Commit message must be in the format of
+          # "chore: release vX.X"
+          VERSION=$(echo "$COMMIT_MESSAGE" | grep -oP '^chore:\ release\ v[a-zA-Z0-9.\-\+]+' | head -n 1 | cut -d' ' -f3)
+          if [[ -z "$VERSION" ]]; then
+            echo "Commit message does not match the expected format. Please use 'chore: release vX.X.X' format in your commit message."
+            echo "Commit message: $COMMIT_MESSAGE"
+            exit 1
+          fi
+          echo "RELEASE_VERSION=$VERSION" >> "$GITHUB_OUTPUT"
+
+        env:
+          # Avoid script injection by using an environment variable
+          COMMIT_MESSAGE: ${{ github.event.head_commit.message }}
+
+      - name: Parse CHANGELOG.md to get release notes
+        id: parse_changelog
+        uses: kiyoon/parse-changelog-action@v1
+        with:
+          changelog-path: docs/CHANGELOG.md
+          version: ${{ steps.parse_commit.outputs.RELEASE_VERSION }}
+
+      - name: Create Release
+        id: create_release
+        uses: softprops/action-gh-release@v2
+        with:
+          tag_name: ${{ steps.parse_commit.outputs.RELEASE_VERSION }}
+          name: ${{ steps.parse_commit.outputs.RELEASE_VERSION }}
+          body: ${{ steps.parse_changelog.outputs.body }}
+
+  deploy-mkdocs:
+    needs: release
+    uses: deargen/workflows/.github/workflows/deploy-mkdocs.yml@master
+    with:
+      requirements-file: deps/lock/x86_64-manylinux_2_28/requirements_docs.txt
+      gitlab-project: ${{ vars.GITLAB_PROJECT }}
+      gitlab-branch: master
+      version-tag: ${{ needs.release.outputs.RELEASE_VERSION }}
+      deploy-type: tag
+    secrets:
+      GITLAB_TOKEN: ${{ secrets.GITLAB_TOKEN }}

.github/workflows/deploy.yml

@@ -1,13 +1,13 @@
-name: Commit CHANGELOG.md, create a Release and deploy MkDocs
+name: Deploy
 
 on:
   workflow_dispatch:
     inputs:
       version-tag:
         description: Version tag
         required: true
-        default: v0.1.0
-      dry-run:
+        default: 'v0.1.0'
+      dry-run: # print the changelog without creating a PR.
         description: Dry run
         type: boolean
         default: false
@@ -17,23 +17,37 @@ on:
         default: build,docs,style,other
 
 jobs:
-  commit-changelog-and-release:
-    uses: deargen/workflows/.github/workflows/commit-changelog-and-release.yml@master
-    with:
-      version-tag: ${{ github.event.inputs.version-tag }}
-      dry-run: ${{ github.event.inputs.dry-run == 'true' }}
-      changelog-path: docs/CHANGELOG.md
-      exclude-types: ${{ github.event.inputs.exclude-types }}
+  changelog:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
 
-  deploy-mkdocs:
-    if: ${{ github.event.inputs.dry-run == 'false' }}
-    needs: commit-changelog-and-release
-    uses: deargen/workflows/.github/workflows/deploy-mkdocs.yml@master
-    with:
-      requirements-file: deps/lock/x86_64-manylinux_2_28/requirements_docs.txt
-      gitlab-project: ${{ vars.GITLAB_PROJECT }}
-      gitlab-branch: master
-      version-tag: ${{ github.event.inputs.version-tag }}
-      deploy-type: tag
-    secrets:
-      GITLAB_TOKEN: ${{ secrets.GITLAB_TOKEN }}
+      - name: Get CHANGELOG
+        id: changelog
+        uses: kiyoon/changelog-action@v2
+        with:
+          new-version-tag-for-future: ${{ github.event.inputs.version-tag }}
+          tag-prefix: v
+          exclude-types: ${{ github.event.inputs.exclude-types }}
+          write-to-file: true
+          changelog-file-path: docs/CHANGELOG.md
+
+      - name: Display CHANGELOG
+        env:
+          CHANGES_BODY: ${{ steps.changelog.outputs.changes }}
+        run: |
+          echo "${CHANGES_BODY}"
+          echo "${CHANGES_BODY}" > "$GITHUB_STEP_SUMMARY"
+
+      - name: Create PR
+        if: ${{ github.event.inputs.dry-run == 'false' }}
+        uses: peter-evans/create-pull-request@v7
+        with:
+          commit-message: 'chore: release ${{ github.event.inputs.version-tag }}'
+          title: 'chore: release ${{ github.event.inputs.version-tag }}'
+          body: |
+            :robot: The changelog was automatically generated by [kiyoon/changelog-action](https://github.com/kiyoon/changelog-action). :robot:
+          branch: chore/release-${{ github.event.inputs.version-tag }}
+          labels: |
+            release