Replace local script by OpenTermsArchive/changelog-action (#51)

Author: clementbiron

.github/workflows/changelog.yml

@@ -1,18 +1,22 @@
-name: Check changelog
+name: Changelog
 
 on:
-  push:
-    branches-ignore:
-      - main
-      - push-action/** # Temporary branches created by CasperWA/push-protected@v2 action on release workflow
   pull_request:
-    types: [ opened, reopened ]
+  workflow_dispatch:
   workflow_call:
     outputs:
-      release_type:
+      release-type:
         description: The release type extracted from changelog
-        value: ${{ jobs.check_changelog.outputs.release_type }}
+        value: ${{ jobs.validate.outputs.release-type }}
 
 jobs:
-  check_changelog:
-    uses: OpenTermsArchive/engine/.github/workflows/[email protected]
+  validate:
+    runs-on: [ ubuntu-latest ]
+    outputs:
+      release-type: ${{ steps.validate-changelog.outputs.release-type }}
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Validate changelog
+        id: validate-changelog
+        uses: OpenTermsArchive/manage-changelog/[email protected]

.github/workflows/release.yml

@@ -6,64 +6,42 @@ on:
       - main
     types: [ closed ]
 
-
 jobs:
   changelog:
     uses: ./.github/workflows/changelog.yml
   release:
-    if: github.event.pull_request.merged == true
+    if: needs.changelog.outputs.release-type != 'no-release'
     needs: [ changelog ]
     runs-on: ubuntu-latest
     steps:
       - name: Checkout
-        uses: actions/checkout@v2
+        uses: actions/checkout@v4
         with:
           token: ${{ secrets.RELEASE_BOT_GITHUB_TOKEN }}
 
       - name: Configure Git author
         run: |
           git config --global user.name "Open Terms Archive Release Bot"
           git config --global user.email "[email protected]"
-      
-      - name: Install Semver
-        run: npm i -g semver
-
-      - name: Get current version
-        id: get_current_version
-        uses: mikefarah/yq@master
-        with:
-          cmd: yq '.version' galaxy.yml
 
-      - name: Bump version
-        run: |
-          echo "Found release type '${{ env.RELEASE_TYPE }}'"
-          echo "NEW_VERSION=$(semver -i $RELEASE_TYPE ${{ steps.get_current_version.outputs.result }})" >> $GITHUB_ENV
-        env:
-          RELEASE_TYPE: ${{ needs.changelog.outputs.release_type }}
-
-      - name: Update changelog unreleased section with new version
-        uses: superfaceai/release-changelog-action@v2
-        with:
-          path-to-changelog: CHANGELOG.md
-          version: ${{ env.NEW_VERSION }}
-          operation: release
-          format: markdownlint
+      - name: Update changelog for release
+        id: release-changelog
+        uses: OpenTermsArchive/manage-changelog/[email protected]
 
       - name: Build Collection
         uses: artis3n/ansible_galaxy_collection@v2
         with:
           api_key: '${{ secrets.GALAXY_API_KEY }}'
-          galaxy_version: '${{ env.NEW_VERSION }}'
+          galaxy_version: '${{ steps.release-changelog.outputs.version }}'
           build: true
           publish: false
 
-      - name: Commit CHANGELOG.md and create tag
+      - name: Commit CHANGELOG.md and galaxy.yml changes and create tag
         run: |
-          git add "CHANGELOG.md"
-          git add "galaxy.yml"
-          git commit -m "Release ${{ env.NEW_VERSION }}"
-          git tag ${{ env.NEW_VERSION }}
-
+          git add "CHANGELOG.md" "galaxy.yml"
+          git commit -m "Release ${{ steps.release-changelog.outputs.version }}"
+          git tag v${{ steps.release-changelog.outputs.version }}
+      
       - name: Run status checks for release commit on temporary branch # Use temporary branch to enable pushing commits to this branch protected by required status checks 
         uses: CasperWA/push-protected@v2
         with:
@@ -73,24 +51,13 @@ jobs:
 
       - name: Push changes to repository
         run: git push origin && git push --tags
-        env:
-          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-
-      - name: Read version changelog
-        uses: superfaceai/release-changelog-action@v2
-        id: get-changelog
-        with:
-          path-to-changelog: CHANGELOG.md
-          version: ${{ env.NEW_VERSION }}
-          operation: read
 
-      - name: Update GitHub release with changelog
+      - name: Create GitHub release
         uses: softprops/action-gh-release@v1
         with:
-          tag_name: ${{ env.NEW_VERSION }}
-          body: ${{ steps.get-changelog.outputs.changelog }}
-        env:
-          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          tag_name: v${{ steps.release-changelog.outputs.version }}
+          body: ${{ steps.release-changelog.outputs.content }}
+          token: ${{ secrets.RELEASE_BOT_GITHUB_TOKEN }}
 
       - name: Publish Collection on Ansible Galaxy
         uses: artis3n/ansible_galaxy_collection@v2
@@ -99,3 +66,24 @@ jobs:
           build: false
           publish: true
 
+  clean_changelog:
+    if: needs.changelog.outputs.release-type == 'no-release'
+    needs: [ changelog ]
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          token: ${{ secrets.RELEASE_BOT_GITHUB_TOKEN }}
+
+      - name: Configure Git author
+        run: |
+          git config --global user.name "Open Terms Archive Release Bot"
+          git config --global user.email "[email protected]"
+
+      - name: Update changelog for release
+        uses: OpenTermsArchive/manage-changelog/[email protected]
+
+      - name: Erase unreleased information from changelog
+        run: |
+          git commit -m "Clean changelog" CHANGELOG.md
+          git push origin

CHANGELOG.md

@@ -2,6 +2,10 @@
 
 All changes that impact users of this module are documented in this file, in the [Common Changelog](https://common-changelog.org) format with some additional specifications defined in the CONTRIBUTING file. This codebase adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## Unreleased [no-release]
+
+_Modifications made in this changeset do not add, remove or alter any behavior, dependency, API or functionality of the software. They only change non-functional parts of the repository, such as the README file or CI workflows._
+
 ## Unreleased
 
 ## 2.0.2 - 2024-06-12