Repository: ansys/grantami-jobqueue
Pull request #228: Include changelog in documentation
Author: login: ludovicsteinbach
Labels: name: documentation
description: Improvements or additions to documentation
name: maintenance
description: Package and maintenance related
Created: 2025-05-15T11:30:52Z | Merged: 2025-05-21T07:56:31Z

## Include link to relevant issue
Closes #227

## Describe your changes
Re-configure towncrier to write to an rst file
Use the latest template which outputs changelog entries in a table, grouped under tabs by category

All releases of this library were done with auto-generated fragments from PR titles. I have re-generated the rst changelog with changelog fragments from the release branches. This repo can therefore include all the release notes in rst. 
When the docs are released as stable, we'll be able to:
- add a comment to changelog.md to describe where the changelogs are now generated (#231 )
- optionally remove the content of changelog.md as it will duplicate the rst version

Linked issue #227: Migrate changelog to documentation
CI configuration: https://actions.docs.ansys.com/version/stable/migrations/docs-changelog-setup.html#include-the-release-notes-in-your-documentation
Migrate existing changelog entries to rst format

Diff:
diff --git a/doc/changelog.d/228.documentation.md b/doc/changelog.d/228.documentation.md
new file mode 100644
index 00000000..44094bd9
--- /dev/null
+++ b/doc/changelog.d/228.documentation.md
@@ -0,0 +1 @@
+Include changelog in documentation
\ No newline at end of file
diff --git a/doc/changelog.d/changelog_template.jinja b/doc/changelog.d/changelog_template.jinja
index b35bff39..3ca0146b 100644
--- a/doc/changelog.d/changelog_template.jinja
+++ b/doc/changelog.d/changelog_template.jinja
@@ -1,15 +1,22 @@
 {% if sections[""] %}
-{% for category, val in definitions.items() if category in sections[""] %}
 
-### {{ definitions[category]['name'] }}
+.. tab-set::
+
+{%+ for category, val in definitions.items() if category in sections[""] %}
+
+  .. tab-item:: {{ definitions[category]['name'] }}
+
+    .. list-table::
+        :header-rows: 0
+        :widths: auto
 
 {% for text, values in sections[""][category].items() %}
-- {{ text }} {{ values|join(', ') }}
-{% endfor %}
+        * - {{ text }}
+          - {{ values|join(', ') }}
 
 {% endfor %}
+{% endfor %}
+
 {% else %}
 No significant changes.
-
-
-{% endif %}
\ No newline at end of file
+{% endif %}
diff --git a/doc/source/changelog.rst b/doc/source/changelog.rst
new file mode 100644
index 00000000..240b6123
--- /dev/null
+++ b/doc/source/changelog.rst
@@ -0,0 +1,205 @@
+.. _ref_release_notes:
+
+Release notes
+#############
+
+This document contains the release notes for the project.
+
+.. vale off
+
+.. towncrier release notes start
+
+`1.1.0 <https://github.com/ansys/grantami-jobqueue/releases/tag/v1.1.0>`_ - 2024-12-13
+======================================================================================
+
+.. tab-set::
+
+
+  .. tab-item:: Added
+
+    .. list-table::
+        :header-rows: 0
+        :widths: auto
+
+        * - Add support for virtual paths
+          - `#147 <https://github.com/ansys/grantami-jobqueue/pull/147>`_
+
+
+  .. tab-item:: Changed
+
+    .. list-table::
+        :header-rows: 0
+        :widths: auto
+
+        * - Don't generate changelog fragments for dependabot PRs
+          - `#90 <https://github.com/ansys/grantami-jobqueue/pull/90>`_
+
+        * - Update version to v1.1
+          - `#92 <https://github.com/ansys/grantami-jobqueue/pull/92>`_
+
+        * - chore: update CHANGELOG for v1.0.1
+          - `#104 <https://github.com/ansys/grantami-jobqueue/pull/104>`_
+
+        * - Don't create changelog fragments for pre-commit updates
+          - `#121 <https://github.com/ansys/grantami-jobqueue/pull/121>`_
+
+
+  .. tab-item:: Fixed
+
+    .. list-table::
+        :header-rows: 0
+        :widths: auto
+
+        * - Fix 1.0.2 changelog
+          - `#144 <https://github.com/ansys/grantami-jobqueue/pull/144>`_
+
+
+  .. tab-item:: Dependencies
+
+    .. list-table::
+        :header-rows: 0
+        :widths: auto
+
+        * - Bump ServerAPI to 25R1
+          - `#132 <https://github.com/ansys/grantami-jobqueue/pull/132>`_
+
+        * - Upgrade serverapi-openapi to 4.0.0rc0
+          - `#148 <https://github.com/ansys/grantami-jobqueue/pull/148>`_
+
+        * - Bump grantami-serverapi-openapi to 4.0.0
+          - `#149 <https://github.com/ansys/grantami-jobqueue/pull/149>`_
+
+
+  .. tab-item:: Documentation
+
+    .. list-table::
+        :header-rows: 0
+        :widths: auto
+
+        * - Fix link to Issues on contribution page
+          - `#156 <https://github.com/ansys/grantami-jobqueue/pull/156>`_
+
+
+  .. tab-item:: Maintenance
+
+    .. list-table::
+        :header-rows: 0
+        :widths: auto
+
+        * - Auto-approve pre-commit-ci pull requests
+          - `#130 <https://github.com/ansys/grantami-jobqueue/pull/130>`_
+
+        * - Add job to release to private PyPI
+          - `#133 <https://github.com/ansys/grantami-jobqueue/pull/133>`_
+
+        * - chore: update CHANGELOG for v1.0.2
+          - `#141 <https://github.com/ansys/grantami-jobqueue/pull/141>`_
+
+        * - Add release environment in CI and prevent release without successful changelog step
+          - `#143 <https://github.com/ansys/grantami-jobqueue/pull/143>`_
+
+        * - Use Production VM for CI on release branch
+          - `#154 <https://github.com/ansys/grantami-jobqueue/pull/154>`_
+
+        * - Prepare for v1.1.0 release
+          - `#167 <https://github.com/ansys/grantami-jobqueue/pull/167>`_
+
+
+`1.0.2 <https://github.com/ansys/grantami-jobqueue/releases/tag/v1.0.2>`_ - 2024-10-03
+======================================================================================
+
+.. tab-set::
+
+
+  .. tab-item:: Changed
+
+    .. list-table::
+        :header-rows: 0
+        :widths: auto
+
+        * - Use Release VM
+          - `#105 <https://github.com/ansys/grantami-jobqueue/pull/105>`_
+
+
+  .. tab-item:: Fixed
+
+    .. list-table::
+        :header-rows: 0
+        :widths: auto
+
+        * - Handle lack of job specific outputs
+          - `#139 <https://github.com/ansys/grantami-jobqueue/pull/139>`_
+
+        * - Prepare 1.0.2 release
+          - `#140 <https://github.com/ansys/grantami-jobqueue/pull/140>`_
+
+
+  .. tab-item:: Documentation
+
+    .. list-table::
+        :header-rows: 0
+        :widths: auto
+
+        * - Fix installation example for git dependency
+          - `#134 <https://github.com/ansys/grantami-jobqueue/pull/134>`_
+
+        * - Add link to supported authentication schemes
+          - `#135 <https://github.com/ansys/grantami-jobqueue/pull/135>`_
+
+        * - Add link to PyGranta version compatibility documentation
+          - `#136 <https://github.com/ansys/grantami-jobqueue/pull/136>`_
+
+
+  .. tab-item:: Maintenance
+
+    .. list-table::
+        :header-rows: 0
+        :widths: auto
+
+        * - Improve VM management in CI
+          - `#137 <https://github.com/ansys/grantami-jobqueue/pull/137>`_
+
+
+`1.0.1 <https://github.com/ansys/grantami-jobqueue/releases/tag/v1.0.1>`_ - 2024-06-10
+======================================================================================
+
+.. tab-set::
+
+
+  .. tab-item:: Added
+
+    .. list-table::
+        :header-rows: 0
+        :widths: auto
+
+        * - Clarify meaning of JobStatus enum and ensure more import failures result in 'Failed' status
+          - `#98 <https://github.com/ansys/grantami-jobqueue/pull/98>`_
+
+
+  .. tab-item:: Changed
+
+    .. list-table::
+        :header-rows: 0
+        :widths: auto
+
+        * - CI - 64 - Add doc-changelog action
+          - `#78 <https://github.com/ansys/grantami-jobqueue/pull/78>`_
+
+        * - Use trusted publisher
+          - `#102 <https://github.com/ansys/grantami-jobqueue/pull/102>`_
+
+        * - Cherry pick PR #102
+          - `#103 <https://github.com/ansys/grantami-jobqueue/pull/103>`_
+
+
+  .. tab-item:: Dependencies
+
+    .. list-table::
+        :header-rows: 0
+        :widths: auto
+
+        * - Prepare 1.0.1 release
+          - `#101 <https://github.com/ansys/grantami-jobqueue/pull/101>`_
+
+
+.. vale on
\ No newline at end of file
diff --git a/doc/source/conf.py b/doc/source/conf.py
index a4110450..3465fa7e 100644
--- a/doc/source/conf.py
+++ b/doc/source/conf.py
@@ -17,6 +17,7 @@
 project_copyright = f"(c) {now.year} ANSYS, Inc. All rights reserved"
 author = "ANSYS, Inc."
 release = version = __version__
+switcher_version = get_version_match(version)
 
 # Select desired logo, theme, and declare the html title
 html_logo = pyansys_logo_black
@@ -38,11 +39,19 @@
     ],
     "switcher": {
         "json_url": f"https://{cname}/versions.json",
-        "version_match": get_version_match(__version__),
+        "version_match": switcher_version,
     },
     "check_switcher": False,
 }
 
+linkcheck_ignore = []
+# If we are on a release, we have to ignore the "release" URLs, since it is not
+# available until the release is published.
+if switcher_version != "dev":
+    linkcheck_ignore.append(
+        f"https://github.com/ansys/grantami-jobqueue/releases/tag/v{__version__}"
+    )
+
 # Sphinx extensions
 extensions = [
     "numpydoc",
diff --git a/doc/source/index.rst b/doc/source/index.rst
index 0af4d479..2d97a6e6 100644
--- a/doc/source/index.rst
+++ b/doc/source/index.rst
@@ -55,3 +55,4 @@ Python interface to the Granta JobQueue API.
    api/index
    examples/index
    contributing
+   changelog
diff --git a/pyproject.toml b/pyproject.toml
index 96ad09cc..1cbe51c4 100644
--- a/pyproject.toml
+++ b/pyproject.toml
@@ -135,12 +135,11 @@ exclude = [  # don't report on objects that match any of these regexes
 [tool.towncrier]
 package = "ansys.grantami.jobqueue"
 directory = "doc/changelog.d"
-filename = "CHANGELOG.md"
-start_string = "<!-- towncrier release notes start -->\n"
-underlines = ["", "", ""]
+filename = "doc/source/changelog.rst"
+start_string = ".. towncrier release notes start\n"
 template = "doc/changelog.d/changelog_template.jinja"
-title_format = "## [{version}](https://github.com/ansys/grantami-jobqueue/releases/tag/v{version}) - {project_date}"
-issue_format = "[#{issue}](https://github.com/ansys/grantami-jobqueue/pull/{issue})"
+title_format = "`{version} <https://github.com/ansys/grantami-jobqueue/releases/tag/v{version}>`_ - {project_date}"
+issue_format = "`#{issue} <https://github.com/ansys/grantami-jobqueue/pull/{issue}>`_"
 
 [[tool.towncrier.type]]
 directory = "added"
@@ -166,6 +165,7 @@ showcontent = true
 directory = "miscellaneous"
 name = "Miscellaneous"
 showcontent = true
+
 [[tool.towncrier.type]]
 directory = "documentation"
 name = "Documentation"


Reviews:
user: login: da1910
state: APPROVED
author_association: CONTRIBUTOR
submitted_at: 2025-05-15T11:34:21Z
user: login: Andy-Grigg
state: COMMENTED
author_association: COLLABORATOR
submitted_at: 2025-05-16T06:43:31Z
user: login: ludovicsteinbach
state: COMMENTED
author_association: CONTRIBUTOR
submitted_at: 2025-05-19T12:45:07Z
user: login: Andy-Grigg
body: We probably want to revert the changes to CHANGELOG.md in this PR, and then make these changes in a PR following the release.
state: CHANGES_REQUESTED
author_association: COLLABORATOR
submitted_at: 2025-05-19T14:06:28Z
user: login: Andy-Grigg
body: Can you create an issue to re-configure/delete the changelog.md file following release?
state: APPROVED
author_association: COLLABORATOR
submitted_at: 2025-05-20T13:32:46Z

Review comments:
diff_hunk: @@ -1,10 +1,11 @@
 # Changelog
 
-This project uses [towncrier](https://towncrier.readthedocs.io/) and the
-changes for the upcoming release can be found in
+This project uses [towncrier](https://towncrier.readthedocs.io/) to generate changelogs.
+
+The changes for the upcoming release can be found in
 <https://github.com/ansys/grantami-jobqueue/tree/main/doc/changelog.d/>.
 
-<!-- towncrier release notes start -->
+[Published release notes](https://jobqueue.grantami.docs.pyansys.com/version/stable/changelog.html) can be found in the online documentation.]
path: CHANGELOG.md
user: login: Andy-Grigg
body: I assume this is from the standard template, but "Published release notes" seems like an odd way to describe the difference between md and rst formats. These release notes are still published, they're just published in a markdown document.

Maybe "Release notes for more recent releases can be found in the online documentation." and have the link on the "online documentation" text?
created_at: 2025-05-16T06:43:31Z
author_association: COLLABORATOR
diff_hunk: @@ -1,10 +1,11 @@
 # Changelog
 
-This project uses [towncrier](https://towncrier.readthedocs.io/) and the
-changes for the upcoming release can be found in
+This project uses [towncrier](https://towncrier.readthedocs.io/) to generate changelogs.
+
+The changes for the upcoming release can be found in
 <https://github.com/ansys/grantami-jobqueue/tree/main/doc/changelog.d/>.
 
-<!-- towncrier release notes start -->
+[Published release notes](https://jobqueue.grantami.docs.pyansys.com/version/stable/changelog.html) can be found in the online documentation.]
path: CHANGELOG.md
user: login: ludovicsteinbach
body: That's not from the migration guide or dev guide, but it is used in a couple of major pyansys libraries. I've updated it


created_at: 2025-05-19T12:45:07Z
author_association: CONTRIBUTOR
diff_hunk: @@ -1,90 +1,8 @@
 # Changelog
 
-This project uses [towncrier](https://towncrier.readthedocs.io/) and the
-changes for the upcoming release can be found in
-<https://github.com/ansys/grantami-jobqueue/tree/main/doc/changelog.d/>.
-
-<!-- towncrier release notes start -->
-
-## [1.1.0](https://github.com/ansys/grantami-jobqueue/releases/tag/v1.1.0) - 2024-12-13
-
-
-### Added
-
-- Add support for virtual paths [#147](https://github.com/ansys/grantami-jobqueue/pull/147)
-
-
-### Changed
-
-- Don't generate changelog fragments for dependabot PRs [#90](https://github.com/ansys/grantami-jobqueue/pull/90)
-- Update version to v1.1 [#92](https://github.com/ansys/grantami-jobqueue/pull/92)
-- chore: update CHANGELOG for v1.0.1 [#104](https://github.com/ansys/grantami-jobqueue/pull/104)
-- Don't create changelog fragments for pre-commit updates [#121](https://github.com/ansys/grantami-jobqueue/pull/121)
-
-
-### Fixed
-
-- Fix 1.0.2 changelog [#144](https://github.com/ansys/grantami-jobqueue/pull/144)
-
-
-### Dependencies
-
-- Bump ServerAPI to 25R1 [#132](https://github.com/ansys/grantami-jobqueue/pull/132)
-- Upgrade serverapi-openapi to 4.0.0rc0 [#148](https://github.com/ansys/grantami-jobqueue/pull/148)
-- Bump grantami-serverapi-openapi to 4.0.0 [#149](https://github.com/ansys/grantami-jobqueue/pull/149)
-
-
-### Documentation
-
-- Fix link to Issues on contribution page [#156](https://github.com/ansys/grantami-jobqueue/pull/156)
-
-
-### Maintenance
+This project uses [towncrier](https://towncrier.readthedocs.io/) to generate changelogs.
 
-- Auto-approve pre-commit-ci pull requests [#130](https://github.com/ansys/grantami-jobqueue/pull/130)
-- Add job to release to private PyPI [#133](https://github.com/ansys/grantami-jobqueue/pull/133)
-- chore: update CHANGELOG for v1.0.2 [#141](https://github.com/ansys/grantami-jobqueue/pull/141)
-- Add release environment in CI and prevent release without successful changelog step [#143](https://github.com/ansys/grantami-jobqueue/pull/143)
-- Use Production VM for CI on release branch [#154](https://github.com/ansys/grantami-jobqueue/pull/154)
-- Prepare for v1.1.0 release [#167](https://github.com/ansys/grantami-jobqueue/pull/167)
-
-## [1.0.2](https://github.com/ansys/grantami-jobqueue/releases/tag/v1.0.2) - 2024-10-03
-
-
-### Changed
-
-- Use Release VM [#105](https://github.com/ansys/grantami-jobqueue/pull/105)
-
-### Documentation
-
-- Fix installation example for git dependency [#134](https://github.com/ansys/grantami-jobqueue/pull/134)
-- Add link to supported authentication schemes [#135](https://github.com/ansys/grantami-jobqueue/pull/135)
-- Add link to PyGranta version compatibility documentation [#136](https://github.com/ansys/grantami-jobqueue/pull/136)
-
-### Maintenance
-
-- Improve VM management in CI [#137](https://github.com/ansys/grantami-jobqueue/pull/137)
-
-### Fixed
-
-- Handle lack of job specific outputs [#139](https://github.com/ansys/grantami-jobqueue/pull/139)
-- Prepare 1.0.2 release [#140](https://github.com/ansys/grantami-jobqueue/pull/140)
-
-## [1.0.1](https://github.com/ansys/grantami-jobqueue/releases/tag/v1.0.1) - 2024-06-10
-
-
-### Added
-
-- Clarify meaning of JobStatus enum and ensure more import failures result in 'Failed' status [#98](https://github.com/ansys/grantami-jobqueue/pull/98)
-
-
-### Changed
-
-- CI - 64 - Add doc-changelog action [#78](https://github.com/ansys/grantami-jobqueue/pull/78)
-- Use trusted publisher [#102](https://github.com/ansys/grantami-jobqueue/pull/102)
-- Cherry pick PR #102 [#103](https://github.com/ansys/grantami-jobqueue/pull/103)
-
-
-### Dependencies
+The changes for the upcoming release can be found in
+<https://github.com/ansys/grantami-jobqueue/tree/main/doc/changelog.d/>.
 
-- Prepare 1.0.1 release [#101](https://github.com/ansys/grantami-jobqueue/pull/101)
+Changes from previous releases can be found in the [online documentation](https://jobqueue.grantami.docs.pyansys.com/version/stable/changelog.html).
path: CHANGELOG.md
user: login: Andy-Grigg
body: This link won't resolve until we do a release of jobqueue with this configuration. The correct thing to do is to probably defer the changes on this file until the documentation is fully published as a release build, to make sure that the changelog is always accessible from a 'primary' location, i.e. main github branch or stable docs.
created_at: 2025-05-19T14:00:43Z
author_association: COLLABORATOR

PR comments:
user: login: github-actions[bot]
created_at: 2025-05-15T11:31:55Z
body: The towncrier template has been successfully rewritten with the default template.
Please ensure that `sphinx-design` is included as a dependency in your project's documentation requirements.
Additionally, add `sphinx-design` to the extensions list in your `conf.py` file.
For more information, please refer to the migration guide at:
https://actions.docs.ansys.com/version/stable/migrations/index.html#migration-guide
author_association: NONE
user: login: codecov-commenter
created_at: 2025-05-15T11:38:44Z
body: ## [Codecov](https://app.codecov.io/gh/ansys/grantami-jobqueue/pull/228?dropdown=coverage&src=pr&el=h1&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=ansys) Report
:white_check_mark: All modified and coverable lines are covered by tests.
:white_check_mark: Project coverage is 88.86%. Comparing base ([`362b767`](https://app.codecov.io/gh/ansys/grantami-jobqueue/commit/362b76739cc3341554fb924f911ec93a9ce02d69?dropdown=coverage&el=desc&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=ansys)) to head ([`53cc45a`](https://app.codecov.io/gh/ansys/grantami-jobqueue/commit/53cc45a473e2a8cc8bc1869013c1dc7fafe9b983?dropdown=coverage&el=desc&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=ansys)).
:warning: Report is 125 commits behind head on main.

<details><summary>Additional details and impacted files</summary>



```diff
@@           Coverage Diff           @@
##             main     #228   +/-   ##
=======================================
  Coverage   88.86%   88.86%           
=======================================
  Files           4        4           
  Lines         557      557           
=======================================
  Hits          495      495           
  Misses         62       62           
```

| [Flag](https://app.codecov.io/gh/ansys/grantami-jobqueue/pull/228/flags?src=pr&el=flags&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=ansys) | Coverage Δ | |
|---|---|---|
| [integration-ubuntu-latest-24.1](https://app.codecov.io/gh/ansys/grantami-jobqueue/pull/228/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=ansys) | `43.98% <ø> (ø)` | |
| [integration-ubuntu-latest-24.2](https://app.codecov.io/gh/ansys/grantami-jobqueue/pull/228/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=ansys) | `86.53% <ø> (ø)` | |
| [integration-ubuntu-latest-25.1](https://app.codecov.io/gh/ansys/grantami-jobqueue/pull/228/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=ansys) | `86.35% <ø> (-0.18%)` | :arrow_down: |
| [integration-ubuntu-latest-25.2](https://app.codecov.io/gh/ansys/grantami-jobqueue/pull/228/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=ansys) | `85.27% <ø> (ø)` | |
| [integration-windows-latest-24.1](https://app.codecov.io/gh/ansys/grantami-jobqueue/pull/228/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=ansys) | `43.98% <ø> (ø)` | |
| [integration-windows-latest-24.2](https://app.codecov.io/gh/ansys/grantami-jobqueue/pull/228/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=ansys) | `86.53% <ø> (ø)` | |
| [integration-windows-latest-25.1](https://app.codecov.io/gh/ansys/grantami-jobqueue/pull/228/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=ansys) | `86.53% <ø> (ø)` | |
| [integration-windows-latest-25.2](https://app.codecov.io/gh/ansys/grantami-jobqueue/pull/228/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=ansys) | `85.27% <ø> (ø)` | |
| [unittests](https://app.codecov.io/gh/ansys/grantami-jobqueue/pull/228/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=ansys) | `63.37% <ø> (ø)` | |

Flags with carried forward coverage won't be shown. [Click here](https://docs.codecov.io/docs/carryforward-flags?utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=ansys#carryforward-flags-in-the-pull-request-comment) to find out more.
</details>

[:umbrella: View full report in Codecov by Sentry](https://app.codecov.io/gh/ansys/grantami-jobqueue/pull/228?dropdown=coverage&src=pr&el=continue&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=ansys).   
:loudspeaker: Have feedback on the report? [Share it here](https://about.codecov.io/codecov-pr-comment-feedback/?utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=ansys).
<details><summary> :rocket: New features to boost your workflow: </summary>

- :snowflake: [Test Analytics](https://docs.codecov.com/docs/test-analytics): Detect flaky tests, report on failures, and find test suite problems.
</details>
author_association: NONE
user: login: Andy-Grigg
created_at: 2025-05-15T14:19:09Z
body: If the recommended approach is to just point to the previous markdown document, then I'm happy with this approach as well.
author_association: COLLABORATOR
user: login: ludovicsteinbach
created_at: 2025-05-15T14:24:04Z
body: I think I need to at least update changelog.md to include that going forward, release notes are in the docs.
I'll try to regenerate old release notes in the new format on this repo - there are only a couple releases so it should be quick
author_association: CONTRIBUTOR