Changelog generation for the automated releases (#4574)

* Create changelog workflow * Change env variables. * Add TODOs. * Update changelog generator workflow. * Fix copy-paste typo :) * Print changelog inside code snippet * Update comment changes. * Add --onlyShowMissing support. * Fix typo * Create CHANGELOG_TOKEN secret * Revert GITHUB_TOKEN * Fix typo * Fix HEAD * Use Kong as OWNER * Update .github/workflows/changelog.yml Co-authored-by: David Marby <david@dmarby.se> * Add support for PR trigger & always run onlyShowMissing. * Fix text * Fix ref and if clauses * Fix ref and if clauses * Add notice in case changelogs fail. * Change get latest release. * Fix typo * Remove unnecessary TODO Co-authored-by: David Marby <david@dmarby.se>
2024-11-07 22:30:15 +00:00 · 2022-03-23 11:57:51 +00:00 · 2022-03-23 11:57:51 +00:00 · dee0b47039
commit dee0b47039
parent a4369bea1e
1 changed files with 128 additions and 0 deletions
--- a/.github/workflows/changelog.yml
+++ b/.github/workflows/changelog.yml
@ -0,0 +1,128 @@
+name: Generate Changelog
+
+on:
+  workflow_dispatch:
+    inputs:
+      version:
+        required: true
+        description: Release version (e.g. 2022.1.0 or 2022.1.0-beta.0)
+  pull_request:
+    types:
+      - opened
+      - synchronize
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
+
+jobs:
+  generate-changelog:
+    if: "startsWith(github.head_ref, 'release/') || github.event_name == 'workflow_dispatch'"
+    runs-on: ubuntu-latest
+    steps:
+
+      - name: Set release version Env (workflow_dispatch)
+        if: github.event_name == 'workflow_dispatch'
+        shell: bash
+        run: |
+           echo "RELEASE_VERSION=${{ github.event.inputs.version }} " >> $GITHUB_ENV
+
+      - name: Set release version Env (pull_request)
+        if: "startsWith(github.head_ref, 'release/')"
+        shell: bash
+        run: |
+           echo "RELEASE_VERSION=${BRANCH/release\//} " >> $GITHUB_ENV
+        env:
+          BRANCH: ${{ github.head_ref }}
+
+      - name: Find Pull Request
+        uses: juliangruber/find-pull-request-action@v1
+        id: find-pull-request
+        with:
+          branch: release/${{ env.RELEASE_VERSION }}
+
+      - name: Setup Node
+        uses: actions/setup-node@v3
+
+      - name: Get latest release for Changelog
+        id: latest_release
+        uses: cardinalby/git-get-release-action@v1
+        env:
+          GITHUB_TOKEN: ${{ github.token }}
+        with:
+          draft: false
+          prerelease: false
+          releaseNameRegEx: Insomnia .*
+          repo: ${{github.repository}}
+
+      - name: Run Changelog-generator script
+        id: changelog
+        shell: bash
+        run: |
+          npx @kong/changelog-generator generate \
+            --owner ${OWNER} \
+            --repo insomnia \
+            --base ${{ steps.latest_release.outputs.tag_name }} \
+            --head ${HEAD} \
+            --releaseName "${RELEASE_NAME}" > ./temp_changelog.out
+
+          npx @kong/changelog-generator generate \
+            --owner ${OWNER} \
+            --repo insomnia \
+            --base ${{ steps.latest_release.outputs.tag_name }} \
+            --head ${HEAD} \
+            --releaseName "${RELEASE_NAME}" --onlyShowMissing > ./temp_changelog_missing.out
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          OWNER: ${{ github.repository_owner }}
+          HEAD: release/${{ env.RELEASE_VERSION }}
+          RELEASE_NAME: ${{ env.RELEASE_VERSION }}
+          SHOW_MISSING: ${{ env.SHOW_MISSING }}
+
+      - name: Read changelog
+        id: read-changelog
+        uses: juliangruber/read-file-action@v1
+        with:
+          path: ./temp_changelog.out
+
+      - name: Read changelog (missing)
+        id: read-changelog-missing
+        uses: juliangruber/read-file-action@v1
+        with:
+          path: ./temp_changelog_missing.out
+
+      - name: Set timestamp
+        id: timestamp
+        run: echo "::set-output name=timestamp::$(date --iso-8601=seconds)"
+
+      - name: Find Comment
+        uses: peter-evans/find-comment@v1
+        id: find-comment
+        with:
+          issue-number: ${{ steps.find-pull-request.outputs.number }}
+          body-includes: Auto-generated changelog
+
+      - name: Create or update comment
+        uses: peter-evans/create-or-update-comment@v1
+        with:
+          comment-id: ${{ steps.find-comment.outputs.comment-id }}
+          issue-number: ${{ steps.find-pull-request.outputs.number }}
+          body: |
+            Auto-generated changelog:
+            ```
+            ${{ steps.read-changelog.outputs.content }}
+            ```
+
+            PRs missing a `changelog(<type>): <description>`:
+            ```
+            ${{ steps.read-changelog-missing.outputs.content }}
+            ```
+            Last Updated: ${{ steps.timestamp.outputs.timestamp }}
+
+            To re-trigger:
+            - Via UI, run [Generate Changelog workflow](https://github.com/${{ github.repository }}/actions/workflows/changelog.yml) (`version`): `${{ env.RELEASE_VERSION }}`
+            - Via CLI, run [Github CLI](https://cli.github.com/):
+            ```bash
+            gh workflow run changelog.yml -f version=${{ env.RELEASE_VERSION }} --repo ${{ github.repository }}
+            ```
+          edit-mode: replace