-
Notifications
You must be signed in to change notification settings - Fork 22
DOCS: Add the changelog feature #1593
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
|
@SMoraisAnsys, tagging you here essentially to make sure that the |
|
@svandenb-dev, I noticed that the |
Codecov Report✅ All modified and coverable lines are covered by tests. 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:
|
svandenb-dev
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM
SMoraisAnsys
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM
This PR is implementing the
ansys/actions/doc-changelogin.github/workflows/label.ymland theansys/actions/doc-deploy-changelogin.github/workflows/ci_cd.yml.Combined, these actions will automatically generate a changelog section inside the
pyedbdocumentation, making it easier for users to get an overview about the chronology of the latest changes.The two
ansys/actionsare 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.dfolder. Upon each new release, these fragments will be assembled to form the release notes that will be added to the documentation in thedoc/source/changelog.rstfile. 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.rstfile.