Update GitHub workflows (#51)

Takishima · web-flow · commit 717ec81b4bad · 2023-05-30T22:53:07.000+02:00
* Make CHANGELOG release names more consistent

* Run mdformat-gfm on CHANGELOG

* Add GitHub workflow to handle pre-commit.ci updates automatically

* Minor cleanup for CHANGELOG
diff --git a/.github/workflows/draft_release.yml b/.github/workflows/draft_release.yml
@@ -2,11 +2,11 @@
 
 name: "Draft new release"
 
-on:
+on:  # yamllint disable-line rule:truthy
   workflow_dispatch:
     inputs:
-      version:
-        description: 'Version to release'
+      tag:
+        description: 'Version to release (format: vXX.YY.ZZ)'
         required: true
 
 jobs:
@@ -16,43 +16,41 @@ jobs:
     steps:
       - uses: actions/checkout@v3
 
-      - name: Create release branch
-        run: |
-          git checkout -b release/${{ github.event.inputs.version }}
-
-      - name: Update changelog
-        uses: thomaseizinger/keep-a-changelog-new-release@1.3.0
+      - name: Setup Python
+        uses: actions/setup-python@v3
         with:
-          version: ${{ github.event.inputs.version }}
+          python-version: '3.11'
+          cache: 'pip'
+          cache-dependency-path: '**/setup.cfg'
 
-      - name: Initialize mandatory git config
+      - name: Update CHANGELOG
         run: |
-          git config user.name "GitHub actions"
-          git config user.email noreply@github.com
-      - name: Commit changelog and manifest files
+          python3 -m pip install mdformat-gfm 'git+https://github.com/Takishima/keepachangelog@v1.0.1'
+          python3 -m keepachangelog release "${{ github.event.inputs.tag }}"
+          python3 -m mdformat CHANGELOG.md
+
+      - name: Commit changes
+        uses: stefanzweifel/git-auto-commit-action@v4
         id: make-commit
-        run: |
-          git add CHANGELOG.md
-          git commit --message "Preparing release v${{ github.event.inputs.version }}"
-          echo "::set-output name=commit::$(git rev-parse HEAD)"
-      - name: Push new branch
-        run: git push origin release/${{ github.event.inputs.version }}
+        with:
+          branch: release/${{ github.event.inputs.tag }}
+          create_branch: true
+          file_pattern: 'CHANGELOG.md'
+          commit_message: Preparing release ${{ github.event.inputs.tag }}
+          commit_author: github-actions[bot] <noreply@github.com>
 
       # yamllint disable rule:line-length
       - name: Create pull request
         uses: thomaseizinger/create-pull-request@1.3.0
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
         with:
-          head: release/${{ github.event.inputs.version }}
+          head: release/${{ github.event.inputs.tag }}
           base: main
-          title: Release version ${{ github.event.inputs.version }}
+          title: Release version ${{ github.event.inputs.tag }}
           reviewers: ${{ github.actor }}
-          # Write a nice message to the user.
-          # We are claiming things here based on the `publish-new-release.yml` workflow.
-          # You should obviously adopt it to say the truth depending on your release workflow :)
           body: |
             Hi @${{ github.actor }}!
             This PR was created in response to a manual trigger of the release workflow here: https://github.com/${{ github.repository }}/actions/runs/${{ github.run_id }}.
-            I've updated the changelog and bumped the versions in the manifest files in this commit: ${{ steps.make-commit.outputs.commit }}.
+            I've updated the changelog and bumped the versions in the manifest files in this commit: ${{ steps.make-commit.outputs.commit_hash }}.
             Merging this PR will create a GitHub release and upload any assets that are created as part of the release build.
diff --git a/.github/workflows/pre-commit-ci.yml b/.github/workflows/pre-commit-ci.yml
@@ -0,0 +1,38 @@
+---
+
+name: Pre-commit CHANGELOG autoupdate
+
+on:  # yamllint disable-line rule:truthy
+  pull_request:
+    types:
+      - opened
+      - reopened
+
+jobs:
+  update-changelog:
+    runs-on: ubuntu-latest
+    name: "Pre-commit CI CHANGELOG auto-update"
+    if: github.event.pull_request.title == '[pre-commit.ci] pre-commit autoupdate'
+    steps:
+      - uses: actions/checkout@v3
+
+      - name: Setup Python
+        uses: actions/setup-python@v3
+        with:
+          python-version: '3.11'
+          cache: 'pip'
+          cache-dependency-path: '**/setup.cfg'
+
+      - name: Install dependencies
+        run: |
+          python3 -m pip install 'git+https://github.com/Takishima/pre-commit-changelog-auto-update@v1.0.0'
+
+      - name: Run Python script
+        run: |
+          python3 -m update_changelog --pr-body "${{ github.event.pull_request.body }}"
+
+      - name: Commit changes
+        uses: stefanzweifel/git-auto-commit-action@v4
+        with:
+          commit_message: Update CHANGELOG
+          commit_author: github-actions[bot] <noreply@github.com>
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -9,149 +9,138 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ### Changed
 
--   Changed minimum Python version to 3.8.X
-
-### Updated
-
--   Update GitHub release publishing workflow
--   Replace most Python pre-commit hooks with [ruff](https://beta.ruff.rs/docs/)
--   Added some more pre-commit hooks:
-    +  doc8
-    +  codespell
-    +  yamllint
-    +  blacken-docs
-    +  pyupgrade
+- Changed minimum Python version to 3.8.X
 
 ### Repository
 
--   Update `thomaseizinger/create-pull-request` GitHub Action to v1.3.0
--   Update `Lucas-C/pre-commit-hooks` hook to v1.5.1
--   Update `black` hook to v23.3.0
--   Update `blacken-docs` hook to v1.13.0
--   Update `pre-commit/pre-commit-hooks` to v4.3.0
--   Update `yamllint` hook to v1.32.0
--   Update `codespell` hook to v2.2.4
-
-## [1.4.1] - 2022-05-04
+- Replace most Python pre-commit hooks with [ruff](https://beta.ruff.rs/docs/)
+- Update release drafting GitHub workflow
+- Add workflow to automatically update CHANGELOG when pre-commit.ci updates happen
+- Added some more pre-commit hooks:
+  - doc8
+  - codespell
+  - yamllint
+  - blacken-docs
+- Update `thomaseizinger/create-pull-request` GitHub Action to v1.3.0
+- Update `Lucas-C/pre-commit-hooks` hook to v1.5.1
+- Update `black` hook to v23.3.0
+- Update `blacken-docs` hook to v1.13.0
+- Update `pre-commit/pre-commit-hooks` to v4.3.0
+- Update `yamllint` hook to v1.32.0
+- Update `codespell` hook to v2.2.4
+
+## [v1.4.1] - 2022-05-04
 
 ### Fixed
 
--   Fixed uses of of `pylint.testutils.MessageTest` instead of `pylint.testutils.Message` for Pylint >= 2.12
--   Fixed failing tests due to missing `ignore_position` argument to `assertAddsMessages()`
+- Fixed uses of of `pylint.testutils.MessageTest` instead of `pylint.testutils.Message` for Pylint >= 2.12
+- Fixed failing tests due to missing `ignore_position` argument to `assertAddsMessages()`
 
 ### Repository
 
--   Update `black` hook to v22.3.0
--   Update `check-manifest` hook to v0.48
--   Update `isort` hook to v5.10.1
--   Update `flake8` hook to v4.0.1
--   Update `pre-commit/pre-commit-hooks` to v4.2.0
--   Update `Lucas-C/pre-commit-hooks` hook to v1.2.0
--   Update `dangoslen/changelog-enforcer` GitHub action to v3
--   Update `thomaseizinger/create-pull-request` GitHub action to v1.2.2
--   Update `thomaseizinger/keep-a-changelog-new-release` GitHub action to v1.3.0
--   Update GitHub's CodeQL action to v2
--   Update parse-changelog version to v0.4.7
--   Fixed issue with release publishing GitHub workflow
-
-## [1.4.0] - 2021-07-29
+- Update `black` hook to v22.3.0
+- Update `check-manifest` hook to v0.48
+- Update `isort` hook to v5.10.1
+- Update `flake8` hook to v4.0.1
+- Update `pre-commit/pre-commit-hooks` to v4.2.0
+- Update `Lucas-C/pre-commit-hooks` hook to v1.2.0
+- Update `dangoslen/changelog-enforcer` GitHub action to v3
+- Update `thomaseizinger/create-pull-request` GitHub action to v1.2.2
+- Update `thomaseizinger/keep-a-changelog-new-release` GitHub action to v1.3.0
+- Update GitHub's CodeQL action to v2
+- Update parse-changelog version to v0.4.7
+- Fixed issue with release publishing GitHub workflow
+
+## [v1.4.0] - 2021-07-29
 
 ### Added
 
--   Added W8016 to warn when using `os.mkdir` and `os.makedir` with unsafe permissions (UNIX-only)
--   Added W8017 to warn when using `os.mkfifo` with unsafe permissions (UNIX-only)
--   Added W8018 to warn when using `os.mknod` with unsafe permissions (UNIX-only)
--   Added W8019 to warn when using `os.chmod` with unsafe permissions (all except Windows)
+- Added W8016 to warn when using `os.mkdir` and `os.makedir` with unsafe permissions (UNIX-only)
+- Added W8017 to warn when using `os.mkfifo` with unsafe permissions (UNIX-only)
+- Added W8018 to warn when using `os.mknod` with unsafe permissions (UNIX-only)
+- Added W8019 to warn when using `os.chmod` with unsafe permissions (all except Windows)
 
 ### Updated
 
--   Refactor configuration option parsing for mode-like options
+- Refactor configuration option parsing for mode-like options
 
 ### Fixed
 
--   Critical typo for `msgs` attribute of the plugin class. This effectively rendered any previous version useless as
-    pylint would not recognize the warning/error messages
+- Critical typo for `msgs` attribute of the plugin class. This effectively rendered any previous version useless as
+  pylint would not recognize the warning/error messages
 
 ### Repository
 
--   Restrict running some GitHub actions when a pull request is merged
+- Restrict running some GitHub actions when a pull request is merged
 
-## [1.3.1] - 2021-07-27
+## [v1.3.1] - 2021-07-27
 
 ### Updated
 
--   Update unit tests for `os.open()`
+- Update unit tests for `os.open()`
 
 ### Fixed
 
--   Fix issue when processing keyword arguments for `os.open()`
+- Fix issue when processing keyword arguments for `os.open()`
 
 ### Repository
 
--   Restrict running some GitHub actions only when pull requests are updated
+- Restrict running some GitHub actions only when pull requests are updated
 
-## [1.3.0] - 2021-07-26
+## [v1.3.0] - 2021-07-26
 
 ### Added
 
--   Add plugin option to control whether we favour `os.open` over the builtin `open`
--   Added W8012 to warn when using `os.open` with unsafe permissions
--   Added E8013 to avoid using `pickle.load` and `pickle.loads`
--   Added E8014 to avoid using `marshal.load` and `marshal.loads`
--   Added E8015 to avoid using `shelve.open`
+- Add plugin option to control whether we favour `os.open` over the builtin `open`
+- Added W8012 to warn when using `os.open` with unsafe permissions
+- Added E8013 to avoid using `pickle.load` and `pickle.loads`
+- Added E8014 to avoid using `marshal.load` and `marshal.loads`
+- Added E8015 to avoid using `shelve.open`
 
 ### Fixed
 
--   Fixed a few test function names
+- Fixed a few test function names
 
 ### Repository
 
--   Update pre-commit hooks
--   Update `thomaseizinger/create-pull-request` GiHub action
+- Update pre-commit hooks
+- Update `thomaseizinger/create-pull-request` GiHub action
 
-## [1.2.1] - 2021-07-19
+## [v1.2.1] - 2021-07-19
 
--   Reworded E8003 and extend it to include a few more cases:
-    -   `subprocess.getoutput()`
-    -   `subprocess.getstatusoutput()`
-    -   `asyncio.create_subprocess_shell()`
-    -   `loop.subprocess_shell()`
+- Reworded E8003 and extend it to include a few more cases:
+  - `subprocess.getoutput()`
+  - `subprocess.getstatusoutput()`
+  - `asyncio.create_subprocess_shell()`
+  - `loop.subprocess_shell()`
 
-## [1.2.0] - 2021-07-19
+## [v1.2.0] - 2021-07-19
 
 ### Added
 
--   Added E8010 to avoid using `os.popen()` as it internally uses `subprocess.Popen` with `shell=True`
--   Added E8011 to avoid using `shlex.quote()` on non-POSIX platforms.
+- Added E8010 to avoid using `os.popen()` as it internally uses `subprocess.Popen` with `shell=True`
+- Added E8011 to avoid using `shlex.quote()` on non-POSIX platforms.
 
-## [1.1.0] - 2021-07-02
+## [v1.1.0] - 2021-07-02
 
 ### Added
 
--   Added R8009 to prefer `os.open()` to the builtin `open` when in writing mode
+- Added R8009 to prefer `os.open()` to the builtin `open` when in writing mode
 
 ### Repository
 
--   Update pre-commit configuration
+- Update pre-commit configuration
 
-## [1.0.0] - 2021-06-21
+## [v1.0.0] - 2021-06-21
 
 Initial release
 
-[Unreleased]: https://github.com/Takishima/pylint-secure-coding-standard/compare/v1.4.1...HEAD
-
-[1.4.1]: https://github.com/Takishima/pylint-secure-coding-standard/compare/v1.4.0...v1.4.1
-
-[1.4.0]: https://github.com/Takishima/pylint-secure-coding-standard/compare/v1.3.1...v1.4.0
-
-[1.3.1]: https://github.com/Takishima/pylint-secure-coding-standard/compare/v1.3.0...v1.3.1
-
-[1.3.0]: https://github.com/Takishima/pylint-secure-coding-standard/compare/v1.2.1...v1.3.0
-
-[1.2.1]: https://github.com/Takishima/pylint-secure-coding-standard/compare/v1.2.0...v1.2.1
-
-[1.2.0]: https://github.com/Takishima/pylint-secure-coding-standard/compare/v1.1.0...v1.2.0
-
-[1.1.0]: https://github.com/Takishima/pylint-secure-coding-standard/compare/v1.0.0...v1.1.0
-
-[1.0.0]: https://github.com/Takishima/pylint-secure-coding-standard/compare/375145a3dec096ff4e33901ef749a1a9a6f4edc6...v1.0.0
+[unreleased]: https://github.com/Takishima/pylint-secure-coding-standard/compare/v1.4.1...HEAD
+[v1.0.0]: https://github.com/Takishima/pylint-secure-coding-standard/compare/375145a3dec096ff4e33901ef749a1a9a6f4edc6...v1.0.0
+[v1.1.0]: https://github.com/Takishima/pylint-secure-coding-standard/compare/v1.0.0...v1.1.0
+[v1.2.0]: https://github.com/Takishima/pylint-secure-coding-standard/compare/v1.1.0...v1.2.0
+[v1.2.1]: https://github.com/Takishima/pylint-secure-coding-standard/compare/v1.2.0...v1.2.1
+[v1.3.0]: https://github.com/Takishima/pylint-secure-coding-standard/compare/v1.2.1...v1.3.0
+[v1.3.1]: https://github.com/Takishima/pylint-secure-coding-standard/compare/v1.3.0...v1.3.1
+[v1.4.0]: https://github.com/Takishima/pylint-secure-coding-standard/compare/v1.3.1...v1.4.0
+[v1.4.1]: https://github.com/Takishima/pylint-secure-coding-standard/compare/v1.4.0...v1.4.1
