feat: add whatsnew options

.github/workflows/ci_cd.yml

@@ -45,6 +45,19 @@ jobs:
       pull-requests: write
     runs-on: ubuntu-latest
     steps:
+      - name: "Setup python"
+        uses: actions/setup-python@v5
+        with:
+          python-version: ${{ env.MAIN_PYTHON_VERSION }}
+
+      - name: "Checkout repo"
+        uses: actions/checkout@v4
+
+      - name: "Install dependencies"
+        run: |
+          python -m pip install --upgrade pip
+          pip install -e .[changelog]
+
       - uses: ansys/actions/doc-changelog@v8
         if: ${{ github.event_name == 'pull_request' }}
         with:

.pre-commit-config.yaml

@@ -33,7 +33,7 @@ repos:
     - id: check-github-workflows
 
 - repo: https://github.com/ansys/pre-commit-hooks
-  rev: v0.4.4
+  rev: v0.5.1
   hooks:
   - id: add-license-headers
     files: '(src|doc/source/examples)/.*\.(py)'

doc/changelog.d/583.maintenance.md

@@ -0,0 +1 @@
+feat: add whatsnew options

doc/changelog.d/changelog_template.jinja

@@ -1,17 +1,17 @@
-{% if sections[""] %}
-{% for category, val in definitions.items() if category in sections[""] %}
-
-{{ definitions[category]['name'] }}
-{% set underline = '^' * definitions[category]['name']|length %}
-{{ underline }}
-
-{% for text, values in sections[""][category].items() %}
-- {{ text }} {{ values|join(', ') }}
-{% endfor %}
-
-{% endfor %}
-{% else %}
-No significant changes.
-
-
-{% endif %}
+{% if sections[""] %}
+{% for category, val in definitions.items() if category in sections[""] %}
+
+{{ definitions[category]['name'] }}
+{% set underline = '^' * definitions[category]['name']|length %}
+{{ underline }}
+
+{% for text, values in sections[""][category].items() %}
+- {{ text }} {{ values|join(', ') }}
+{% endfor %}
+
+{% endfor %}
+{% else %}
+No significant changes.
+
+
+{% endif %}

doc/source/changelog.rst

@@ -1,10 +1,9 @@
+
 .. _ref_release_notes:
 
 Release notes
 #############
 
-This document contains the release notes for the project.
-
 .. vale off
 
 .. towncrier release notes start