use towncrier to handle changelog entries
#1375
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
zacharyburnett
added
the
documentation
github-actions
bot
added
dependencies
zacharyburnett
commented
Aug 22, 2024
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #1375 +/- ##
=======================================
Coverage 78.49% 78.49%
=======================================
Files 117 117
Lines 7867 7867
=======================================
Hits 6175 6175
Misses 1692 1692
*This pull request uses carry forward flags. Click here to find out more. ☔ View full report in Codecov by Sentry. |
zacharyburnett
added
no-changelog-entry-needed
and removed
no-changelog-entry-needed
labels
zacharyburnett
added
no-changelog-entry-needed
and removed
no-changelog-entry-needed
labels
zacharyburnett
commented
Aug 27, 2024
.github/pull_request_template.md
Outdated
Comment on lines
11
to
12
| **Checklist** | ||
| - [ ] added entry in `CHANGES.rst` under the corresponding subsection | ||
| - [ ] for a public change, added a [towncrier news fragment](https://towncrier.readthedocs.io/en/stable/tutorial.html#creating-news-fragments) <details><summary>`changes/<PR#>.<changetype>.rst`</summary> |
There was a problem hiding this comment.
Checklist
-
for a public change, added a towncrier news fragment
changes/<PR#>.<changetype>.rstchanges/<PR#>.general.rst: infrastructure or miscellaneous changechanges/<PR#>.docs.rstchanges/<PR#>.stpipe.rstchanges/<PR#>.associations.rstchanges/<PR#>.scripts.rstchanges/<PR#>.mosaic_pipeline.rstchanges/<PR#>.patch_match.rst
steps
changes/<PR#>.dq_init.rstchanges/<PR#>.saturation.rstchanges/<PR#>.refpix.rstchanges/<PR#>.linearity.rstchanges/<PR#>.dark_current.rstchanges/<PR#>.jump_detection.rstchanges/<PR#>.ramp_fitting.rstchanges/<PR#>.assign_wcs.rstchanges/<PR#>.flatfield.rstchanges/<PR#>.photom.rstchanges/<PR#>.flux.rstchanges/<PR#>.source_detection.rstchanges/<PR#>.tweakreg.rstchanges/<PR#>.skymatch.rstchanges/<PR#>.outlier_detection.rstchanges/<PR#>.resample.rstchanges/<PR#>.source_catalog.rst
-
updated relevant tests
-
updated relevant documentation
-
updated relevant milestone(s)
zacharyburnett
force-pushed
the
changelog/towncrier
branch
from
b996c73 to
4e78e85
Compare
zacharyburnett
force-pushed
the
changelog/towncrier
branch
from
4e78e85 to
75c85e4
Compare
|
current changelog ( 0.16.2.dev2+g482ef5c7 (2024-08-27)
==================================
Documentation
-------------
- handle changelog entries with `towncrier` (`#1375
<https://github.com/spacetelescope/romancal/1375>`_)
``mosaic_pipeline``
-------------------
- Only load patch table when needed. (`#1367
<https://github.com/spacetelescope/romancal/1367>`_) |
zacharyburnett
force-pushed
the
changelog/towncrier
branch
from
75c85e4 to
8c071b6
Compare
zacharyburnett
commented
Aug 28, 2024
Comment on lines
11
to
43
| **Checklist** | ||
| - [ ] added entry in `CHANGES.rst` under the corresponding subsection | ||
| - [ ] for a public change, added a towncrier news fragment in `changes/` <details><summary>`echo "changed something" > changes/<PR#>.<changetype>.rst`</summary> | ||
|
|
||
| - ``changes/<PR#>.general.rst``: infrastructure or miscellaneous change | ||
| - ``changes/<PR#>.docs.rst`` | ||
| - ``changes/<PR#>.stpipe.rst`` | ||
| - ``changes/<PR#>.associations.rst`` | ||
| - ``changes/<PR#>.scripts.rst`` | ||
| - ``changes/<PR#>.mosaic_pipeline.rst`` | ||
| - ``changes/<PR#>.patch_match.rst`` | ||
|
|
||
| ## steps | ||
| - ``changes/<PR#>.dq_init.rst`` | ||
| - ``changes/<PR#>.saturation.rst`` | ||
| - ``changes/<PR#>.refpix.rst`` | ||
| - ``changes/<PR#>.linearity.rst`` | ||
| - ``changes/<PR#>.dark_current.rst`` | ||
| - ``changes/<PR#>.jump_detection.rst`` | ||
| - ``changes/<PR#>.ramp_fitting.rst`` | ||
| - ``changes/<PR#>.assign_wcs.rst`` | ||
| - ``changes/<PR#>.flatfield.rst`` | ||
| - ``changes/<PR#>.photom.rst`` | ||
| - ``changes/<PR#>.flux.rst`` | ||
| - ``changes/<PR#>.source_detection.rst`` | ||
| - ``changes/<PR#>.tweakreg.rst`` | ||
| - ``changes/<PR#>.skymatch.rst`` | ||
| - ``changes/<PR#>.outlier_detection.rst`` | ||
| - ``changes/<PR#>.resample.rst`` | ||
| - ``changes/<PR#>.source_catalog.rst`` | ||
| </details> | ||
| - [ ] updated relevant tests | ||
| - [ ] updated relevant documentation | ||
| - [ ] updated relevant milestone(s) |
There was a problem hiding this comment.
Checklist
-
for a public change, added a towncrier news fragment in
changes/echo "changed something" > changes/<PR#>.<changetype>.rstchanges/<PR#>.general.rst: infrastructure or miscellaneous changechanges/<PR#>.docs.rstchanges/<PR#>.stpipe.rstchanges/<PR#>.associations.rstchanges/<PR#>.scripts.rstchanges/<PR#>.mosaic_pipeline.rstchanges/<PR#>.patch_match.rst
steps
changes/<PR#>.dq_init.rstchanges/<PR#>.saturation.rstchanges/<PR#>.refpix.rstchanges/<PR#>.linearity.rstchanges/<PR#>.dark_current.rstchanges/<PR#>.jump_detection.rstchanges/<PR#>.ramp_fitting.rstchanges/<PR#>.assign_wcs.rstchanges/<PR#>.flatfield.rstchanges/<PR#>.photom.rstchanges/<PR#>.flux.rstchanges/<PR#>.source_detection.rstchanges/<PR#>.tweakreg.rstchanges/<PR#>.skymatch.rstchanges/<PR#>.outlier_detection.rstchanges/<PR#>.resample.rstchanges/<PR#>.source_catalog.rst
-
updated relevant tests
-
updated relevant documentation
-
updated relevant milestone(s)
|
Do you want to talk about this at the tag up tomorrow (3 pm)? |
sure, where is it? |
zacharyburnett
force-pushed
the
changelog/towncrier
branch
4 times, most recently
from
c33dd3f to
b4ad5c6
Compare
|
@schlafly sorry for the flurry of commits; this should be ready now, if you think it's good to approve. Like in |
zacharyburnett
force-pushed
the
changelog/towncrier
branch
from
039a792 to
1052c7e
Compare
This was referenced Sep 6, 2024
mairanteodoro
pushed a commit
to mairanteodoro/romancal
that referenced
this pull request
Sep 10, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
using
towncrierto handle changelog entries willCHANGES.rstwe currently experience with PRsCHANGES.rstconsistent and eliminate duplicate sectionstowncrierexpects "news fragment" files (text files in thechanges/directory with filenames in the format<PR#>.<changetype>.rst, i.e. for this PR it would bechanges/1375.docs.rst). See docs at https://towncrier.readthedocs.io/en/latest/tutorial.html#creating-news-fragmentswhen ready to make a release, run
towncrier buildto ingest the news fragments and generate a changelog section inCHANGES.rstwith all the new change log entries for that release (this clears thechanges/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 Processwiki page will need to be updated to include a step to runtowncrier buildinstead of manually editingCHANGES.rstChecklist
CHANGES.rstunder the corresponding subsectionupdated relevant testsran regression tests, post a link to the Jenkins job below. How to run regression tests on a PR