Skip to content

Conversation

owenlittlejohns
Copy link
Member

@owenlittlejohns owenlittlejohns commented Sep 23, 2025

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

  • Pull this branch.
  • Run bin/extract-release-notes.sh to ensure the most recent release notes are extracted.
  • To see expected release notes, see HGA example.

PR Acceptance Checklist

  • Jira ticket acceptance criteria met.
  • CHANGELOG.md updated to include high level summary of PR changes.
  • docker/service_version.txt updated if publishing a release. (Change to CI/CD only, no service updates)
  • Tests added/updated and passing.
  • Documentation updated (if needed).

uses: actions/checkout@v5
with:
lfs: true
fetch-depth: 0
Copy link
Member Author

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
Copy link
Member Author

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.

Copy link
Member

@flamingbear flamingbear left a comment

Choose a reason for hiding this comment

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

looks great.

@vutrannasa
Copy link
Contributor

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
Ran script

(base) vtran11@GSLAL0322090499 harmony-opendap-subsetter % git checkout TRT-315-release-notes
branch 'TRT-315-release-notes' set up to track 'origin/TRT-315-release-notes'.
Switched to a new branch 'TRT-315-release-notes'
(base) vtran11@GSLAL0322090499 harmony-opendap-subsetter % bin/extract-release-notes.sh

### Changed

- Release notes for HOSS will now include the commit history for that release.

## Commits

TRT-315: Add commit messages to release notes.

@owenlittlejohns
Copy link
Member Author

owenlittlejohns commented Sep 24, 2025

@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.

Copy link
Contributor

@vutrannasa vutrannasa left a comment

Choose a reason for hiding this comment

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

Nice job!

@owenlittlejohns owenlittlejohns merged commit b7c1eba into main Sep 24, 2025
4 checks passed
@owenlittlejohns owenlittlejohns deleted the TRT-315-release-notes branch September 24, 2025 15:36
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.

3 participants