Skip to content
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

use towncrier to handle changelog entries #284

Merged

Conversation

zacharyburnett
Copy link
Collaborator

@zacharyburnett zacharyburnett commented Aug 27, 2024

using towncrier to handle changelog entries will

  • drastically reduce (or even eliminate) branch conflicts in CHANGES.rst we currently experience with PRs
  • keep the sections in CHANGES.rst consistent and eliminate duplicate sections
  • allow automatic links to be generated in the changelog entries

towncrier expects "news fragment" files (text files in the changes/ directory with filenames in the format <PR#>.<changetype>.rst, i.e. for this PR it would be changes/284.general.rst). See docs at https://towncrier.readthedocs.io/en/latest/tutorial.html#creating-news-fragments

when ready to make a release, run towncrier build to ingest the news fragments and generate a changelog section in CHANGES.rst with all the new change log entries for that release (this clears the changes/ directory of all news fragment files). This step should either be done before making a release, or could probably be added to a GitHub workflow triggered on release (to insert a commit and remake the tag).

After merging this PR the Release Process wiki page will need to be updated to include a step to run towncrier build instead of manually editing CHANGES.rst

Checklist

  • added entry in CHANGES.rst (either in Bug Fixes or Changes to API)
  • updated relevant tests
  • updated relevant documentation
  • updated relevant milestone(s)
  • added relevant label(s)

@zacharyburnett zacharyburnett self-assigned this Aug 27, 2024
@github-actions github-actions bot added documentation Improvements or additions to documentation automation installation labels Aug 27, 2024
@zacharyburnett
Copy link
Collaborator Author

current running change log in docs:
image

Copy link

codecov bot commented Aug 27, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 84.38%. Comparing base (bd72ed5) to head (f637123).
Report is 2 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #284   +/-   ##
=======================================
  Coverage   84.38%   84.38%           
=======================================
  Files          41       41           
  Lines        7557     7557           
=======================================
  Hits         6377     6377           
  Misses       1180     1180           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@zacharyburnett zacharyburnett marked this pull request as ready for review August 27, 2024 17:54
@zacharyburnett zacharyburnett requested a review from a team as a code owner August 27, 2024 17:54
Comment on lines 15 to 24
**Checklist**

- [ ] added entry in `CHANGES.rst` (either in `Bug Fixes` or `Changes to API`)
- [ ] for a public change, added a towncrier news fragment in `changes/`: <details><summary>`echo "changed something" > changes/<PR#>.<changetype>.rst`</summary>

- ``changes/<PR#>.apichange.rst``: change to public API
- ``changes/<PR#>.bugfix.rst``: fixes an issue
- ``changes/<PR#>.general.rst``: infrastructure or miscellaneous change
- [ ] updated relevant tests
- [ ] updated relevant documentation
- [ ] updated relevant milestone(s)
Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Checklist

  • for a public change, added a towncrier news fragment in changes/:

    echo "changed something" > changes/<PR#>.<changetype>.rst

    • changes/<PR#>.apichange.rst: change to public API
    • changes/<PR#>.bugfix.rst: fixes an issue
    • changes/<PR#>.general.rst: infrastructure or miscellaneous change
  • updated relevant tests

  • updated relevant documentation

  • updated relevant milestone(s)

changes/281.bugfix.rst Outdated Show resolved Hide resolved
Copy link
Collaborator

@braingram braingram left a comment

Choose a reason for hiding this comment

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

LGTM!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
automation documentation Improvements or additions to documentation installation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants