feat: add changelog action (#1023)

Co-authored-by: pyansys-ci-bot <[email protected]> Co-authored-by: Roberto Pastor Muela <[email protected]> Co-authored-by: Kathy Pippert <[email protected]>
ansys · Mar 13, 2024 · 6524f6b · 6524f6b
1 parent 4a4c483
commit 6524f6b
Show file tree

Hide file tree

Showing 5 changed files with 71 additions and 1 deletion.
diff --git a/.github/workflows/label.yml b/.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:
@@ -83,3 +87,15 @@ jobs:
           - [good first issue](https://github.com/ansys/pyansys-geometry/pulls?q=label%3Agood+first+issue)
           - [maintenance](https://github.com/ansys/pyansys-geometry/pulls?q=label%3Amaintenance+)
           - [release](https://github.com/ansys/pyansys-geometry/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 }}
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1 +1,5 @@
-# CHANGELOG
+# CHANGELOG
+
+This project uses [towncrier](https://towncrier.readthedocs.io/) to generate changelogs. You can see the changes for the upcoming release in <https://github.com/ansys/{repo-name}/tree/main/changelog.d/>.
+
+<!-- towncrier release notes start -->
diff --git a/doc/changelog.d/1023.added.md b/doc/changelog.d/1023.added.md
@@ -0,0 +1 @@
+feat: add changelog action
diff --git a/doc/changelog.d/changelog_template.jinja b/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 %}
diff --git a/pyproject.toml b/pyproject.toml
@@ -129,3 +129,37 @@ show_missing = true
 minversion = "7.1"
 addopts = "-ra --cov=ansys.geometry --cov-report html:.cov/html --cov-report xml:.cov/xml --cov-report term -vv --image_cache_dir tests/integration/image_cache --add_missing_images"
 testpaths = ["tests"]
+
+[tool.towncrier]
+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/pyansys-geometry/releases/tag/v{version}) - {project_date}"
+issue_format = "[#{issue}](https://github.com/ansys/pyansys-geometry/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