Skip to content

Conversation

@ecoussoux-ansys
Copy link
Collaborator

This PR is implementing the ansys/actions/doc-changelog in .github/workflows/label.yml and the ansys/actions/doc-deploy-changelog in .github/workflows/ci_cd.yml.
Combined, these actions will automatically generate a changelog section inside the pyedb documentation, making it easier for users to get an overview about the chronology of the latest changes.
The two ansys/actions are added following the documentation provided here and here.

For each merged PR, a changelog fragment will now be produced and stored in the doc/changelog.d folder. Upon each new release, these fragments will be assembled to form the release notes that will be added to the documentation in the doc/source/changelog.rst file. Once this operation is performed, the combined fragments will be automatically deleted.
The tool used for the generation of the changelog fragments and release notes is towncrier.
A link to the changelog inside the documentation is also introduced in the doc/source/index.rst file.

@ecoussoux-ansys ecoussoux-ansys self-assigned this Oct 22, 2025
@ecoussoux-ansys ecoussoux-ansys added the documentation Improvements or additions to documentation label Oct 22, 2025
@ecoussoux-ansys
Copy link
Collaborator Author

@SMoraisAnsys, tagging you here essentially to make sure that the pyansys-ci-bot is granted the necessary rights in the repository to run the actions. Thanks!

@github-actions github-actions bot added maintenance Package and maintenance related dependencies Related with project dependencies ci/cd labels Oct 22, 2025
@ecoussoux-ansys
Copy link
Collaborator Author

@svandenb-dev, I noticed that the doc/source/changelog.rst file already existed in pyedb (apparently introduced in #1468), but it seems that it was not really maintained.. it contained only elements related to a release that is more than 1 year old.. The idea with the new actions introduced here is to have the release notes automatically added to that file for every new release going forward.
So what do you think we should do with that older content? Keep it (with maybe some minor additions mentioning that the content is "pre v0.62.0") and simply let the newly introduced actions write the changelogs for the releases to come at the top of the file? Or delete these older entries and start again with a "fresh" changelog?
@SMoraisAnsys, I'd be interested to hear your thoughts on that too, if you have any.
Thanks!

@codecov-commenter
Copy link

codecov-commenter commented Oct 22, 2025

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 70.96%. Comparing base (67790a3) to head (e75aee8).

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #1593   +/-   ##
=======================================
  Coverage   70.96%   70.96%           
=======================================
  Files         267      267           
  Lines       41086    41086           
=======================================
  Hits        29156    29156           
  Misses      11930    11930           
🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

Copy link
Collaborator

@svandenb-dev svandenb-dev left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

Copy link
Collaborator

@SMoraisAnsys SMoraisAnsys left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@ecoussoux-ansys ecoussoux-ansys merged commit 09a3c31 into main Oct 23, 2025
31 checks passed
@ecoussoux-ansys ecoussoux-ansys deleted the docs/add-changelog branch October 23, 2025 08:27
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

ci/cd dependencies Related with project dependencies documentation Improvements or additions to documentation maintenance Package and maintenance related

Projects

None yet

Development

Successfully merging this pull request may close these issues.

6 participants