-
Notifications
You must be signed in to change notification settings - Fork 4
TRT-315: Add commit messages to release notes. #42
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
uses: actions/checkout@v5 | ||
with: | ||
lfs: true | ||
fetch-depth: 0 |
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.
This tells the action to pull all commits on the branch.
uses: actions/checkout@v3 | ||
uses: actions/checkout@v5 | ||
with: | ||
lfs: true |
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.
We don't need git lfs
for this repo. This is some copy-and-paste that has made it into a lot of repos it doesn't need to be.
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.
looks great.
extract-release-notes.sh is used across multiple repos, possible to have one shared version? Would simplify maintenance if there are changes to CHANGE.md Test: Pass
|
@vutrannasa - agreed consolidation, maybe into a GitHub action, would be easier in the long run (I left a similar comment on one of the other PRs for the other repos that have been updated) These PRs address the immediate need for NSIDC verification of what's in future releases, though, and get us to a point where everything is using the same format and extraction script, so it's potentially a step that enables consolidation. |
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.
Nice job!
Description
This PR updates the generation of release notes to include the commit history for the release. This is in response to NSIDC wanting an easier way to map between releases and the work included in them.
I've tweaked the headings of each release in the
CHANGELOG.md
to match the format of other services, so the script extracting releases works as expected. I also added URLs for each existing release.Jira Issue ID
TRT-315 (and other NSIDC verification related tickets)
Local Test Steps
bin/extract-release-notes.sh
to ensure the most recent release notes are extracted.PR Acceptance Checklist
Jira ticket acceptance criteria met.CHANGELOG.md
updated to include high level summary of PR changes.(Change to CI/CD only, no service updates)docker/service_version.txt
updated if publishing a release.Tests added/updated and passing.Documentation updated (if needed).