-
Notifications
You must be signed in to change notification settings - Fork 22
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 change log entries and update new pull request checklist
#442
use towncrier
to handle change log entries and update new pull request checklist
#442
Conversation
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #442 +/- ##
==========================================
+ Coverage 95.38% 95.45% +0.06%
==========================================
Files 4 4
Lines 195 198 +3
==========================================
+ Hits 186 189 +3
Misses 9 9 ☔ View full report in Codecov by Sentry. |
f829276
to
0595c75
Compare
for more information, see https://pre-commit.ci
towncrier
to handle change log entriestowncrier
to handle change log entries and update new pull request checklist
I thought the existing changelog file would be converted to JSON, which would then be used going forward. Did I misunderstand? |
I don't know about that, I considered modifying the existing changelog entries to make the issue numbers have links to the GitHub issue but I'm not sure how useful old changelog entries are (or who looks at them). This PR just changes how new sections are added to |
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.
Just some formatting changes for future PRs.
Co-authored-by: Paul Huwe <42071634+PaulHuwe@users.noreply.github.com>
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
follow-on to spacetelescope/romancal#1375
old checklist
Checklist
CHANGES.rst
under the corresponding subsectionnew checklist
Tasks
rad
testsdocs/
pageno-changelog-entry-needed
)changes/
:echo "changed something" > changes/<PR#>.<changetype>.rst
(see below for change types)roman_datamodels
utilities and testsromancal
regression test with this branch installed ("git+https://github.com/<fork>/rad@<branch>"
)news fragment change types...
changes/<PR#>.apichange.rst
: change to public APIchanges/<PR#>.bugfix.rst
: fixes an issuechanges/<PR#>.general.rst
: infrastructure or miscellaneous change