feat: add doc-changelog and doc-deploy-changelog actions (#164)

Co-authored-by: pyansys-ci-bot <[email protected]>

Author: klmcadams

.github/workflows/ci_cd.yml

@@ -17,6 +17,26 @@ concurrency:
   cancel-in-progress: true
 
 jobs:
+  update-changelog:
+    name: "Update CHANGELOG for new tag"
+    if: github.event_name == 'push' && contains(github.ref, 'refs/tags')
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write
+      pull-requests: write
+    steps:
+      - uses: ansys/actions/doc-deploy-changelog@main
+        with:
+          token: ${{ secrets.PYANSYS_CI_BOT_TOKEN }}
+
+  style:
+    name: Code style
+    runs-on: ubuntu-latest
+    steps:
+      - name: PyAnsys code style checks
+        uses: ansys/actions/code-style@v5
+        with:
+          python-version: ${{ env.MAIN_PYTHON_VERSION }}
 
   doc-style:
     name: "Documentation style"
@@ -89,7 +109,7 @@ jobs:
   release:
     name: "Release project"
     if: github.event_name == 'push' && contains(github.ref, 'refs/tags')
-    needs: [build-library]
+    needs: [build-library, update-changelog]
     runs-on: ubuntu-latest
     steps:
       - name: "Release to the public PyPI repository"
@@ -114,5 +134,3 @@ jobs:
         with:
           cname: ${{ env.DOCUMENTATION_CNAME }}
           token: ${{ secrets.GITHUB_TOKEN }}
-
-

.github/workflows/label.yml

@@ -1,6 +1,10 @@
 name: Labeler
 on:
   pull_request:
+    # opened, reopened, and synchronize are default for pull_request
+    # edited - when PR title or body is changed
+    # labeled - when labels are added to PR
+    types: [opened, reopened, synchronize, edited, labeled]
   push:
     branches: [ main ]
     paths:
@@ -82,3 +86,15 @@ jobs:
           - [good first issue](https://github.com/ansys/pre-commit-hooks/pulls?q=label%3Agood+first+issue)
           - [maintenance](https://github.com/ansys/pre-commit-hooks/pulls?q=label%3Amaintenance+)
           - [release](https://github.com/ansys/pre-commit-hooks/pulls?q=label%3Arelease+)
+
+  changelog-fragment:
+    name: "Create changelog fragment"
+    needs: [labeler]
+    permissions:
+      contents: write
+      pull-requests: write
+    runs-on: ubuntu-latest
+    steps:
+    - uses: ansys/actions/doc-changelog@main
+      with:
+        token: ${{ secrets.PYANSYS_CI_BOT_TOKEN }}

CHANGELOG.md

@@ -2,6 +2,10 @@
 
 This document follows the conventions laid out in [Keep a CHANGELOG](https://keepachangelog.com/en/1.0.0).
 
+This project uses [towncrier](https://towncrier.readthedocs.io/) and the changes for the upcoming release can be found in <https://github.com/ansys/pre-commit-hooks/tree/main/doc/changelog.d/>.
+
+<!-- towncrier release notes start -->
+
 ## [0.2.9](https://github.com/ansys/pre-commit-hooks/releases/tag/v0.2.9) - February 16 2024
 
 ### Changed

doc/changelog.d/164.added.md

@@ -0,0 +1 @@
+feat: add doc-changelog and doc-deploy-changelog actions

doc/changelog.d/changelog_template.jinja

@@ -0,0 +1,15 @@
+{% if sections[""] %}
+{% for category, val in definitions.items() if category in sections[""] %}
+
+### {{ definitions[category]['name'] }}
+
+{% for text, values in sections[""][category].items() %}
+- {{ text }} {{ values|join(', ') }}
+{% endfor %}
+
+{% endfor %}
+{% else %}
+No significant changes.
+
+
+{% endif %}

pyproject.toml

@@ -83,3 +83,38 @@ addopts = "--cov=ansys.pre_commit_hooks --cov-report term-missing -vv"
 testpaths = [
     "tests",
 ]
+
+[tool.towncrier]
+package = "ansys.pre_commit_hooks"
+directory = "doc/changelog.d"
+filename = "CHANGELOG.md"
+start_string = "<!-- towncrier release notes start -->\n"
+underlines = ["", "", ""]
+template = "doc/changelog.d/changelog_template.jinja"
+title_format = "## [{version}](https://github.com/ansys/pre-commit-hooks/releases/tag/v{version}) - {project_date}"
+issue_format = "[#{issue}](https://github.com/ansys/pre-commit-hooks/pull/{issue})"
+
+[[tool.towncrier.type]]
+directory = "added"
+name = "Added"
+showcontent = true
+
+[[tool.towncrier.type]]
+directory = "changed"
+name = "Changed"
+showcontent = true
+
+[[tool.towncrier.type]]
+directory = "fixed"
+name = "Fixed"
+showcontent = true
+
+[[tool.towncrier.type]]
+directory = "dependencies"
+name = "Dependencies"
+showcontent = true
+
+[[tool.towncrier.type]]
+directory = "miscellaneous"
+name = "Miscellaneous"
+showcontent = true