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 change log entries and update new pull request checklist #442

Merged

Conversation

zacharyburnett
Copy link
Collaborator

@zacharyburnett zacharyburnett commented Sep 10, 2024

follow-on to spacetelescope/romancal#1375

old checklist

Checklist

new checklist

Tasks

  • update or add relevant rad tests
  • update relevant docstrings and / or docs/ page
  • Does this PR change schema?
    • schema changes were discussed at RAD Review Board meeting
  • Does this PR change any API used downstream? (if not, label with no-changelog-entry-needed)
    • write news fragment(s) in changes/: echo "changed something" > changes/<PR#>.<changetype>.rst (see below for change types)
    • update relevant roman_datamodels utilities and tests
    • start a romancal regression test with this branch installed ("git+https://github.com/<fork>/rad@<branch>")
news fragment change types...
  • changes/<PR#>.apichange.rst: change to public API
  • changes/<PR#>.bugfix.rst: fixes an issue
  • changes/<PR#>.general.rst: infrastructure or miscellaneous change

@zacharyburnett zacharyburnett self-assigned this Sep 10, 2024
Copy link

codecov bot commented Sep 10, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 95.45%. Comparing base (c1811ab) to head (717bd4e).
Report is 182 commits behind head on main.

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.
📢 Have feedback on the report? Share it here.

@zacharyburnett zacharyburnett marked this pull request as ready for review September 10, 2024 14:39
@zacharyburnett zacharyburnett requested a review from a team as a code owner September 10, 2024 14:39
@zacharyburnett zacharyburnett changed the title use towncrier to handle change log entries use towncrier to handle change log entries and update new pull request checklist Sep 10, 2024
@PaulHuwe
Copy link
Collaborator

I thought the existing changelog file would be converted to JSON, which would then be used going forward. Did I misunderstand?

@zacharyburnett
Copy link
Collaborator Author

zacharyburnett commented Sep 13, 2024

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 CHANGES.rst upon release

Copy link
Collaborator

@PaulHuwe PaulHuwe left a 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.

.github/pull_request_template.md Outdated Show resolved Hide resolved
.github/pull_request_template.md Outdated Show resolved Hide resolved
.github/pull_request_template.md Outdated Show resolved Hide resolved
.github/pull_request_template.md Outdated Show resolved Hide resolved
.github/pull_request_template.md Outdated Show resolved Hide resolved
.github/pull_request_template.md Outdated Show resolved Hide resolved
.github/pull_request_template.md Outdated Show resolved Hide resolved
.github/pull_request_template.md Outdated Show resolved Hide resolved
.github/pull_request_template.md Outdated Show resolved Hide resolved
Co-authored-by: Paul Huwe <42071634+PaulHuwe@users.noreply.github.com>
Copy link
Collaborator

@PaulHuwe PaulHuwe left a comment

Choose a reason for hiding this comment

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

LGTM

@zacharyburnett zacharyburnett merged commit b28fdc3 into spacetelescope:main Sep 16, 2024
13 checks passed
@zacharyburnett zacharyburnett deleted the changelog/towncrier branch September 16, 2024 16:21
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants