Skip to content

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.

Sign up for GitHub

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

Merged
merged 1 commit into from
Sep 24, 2025
Merged

TRT-315: Add commit messages to release notes. #42

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions .github/workflows/publish_docker_image.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,9 +36,9 @@ jobs:

steps:
- name: Checkout harmony-opendap-subsetter repository
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.

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.


- name: Extract semantic version number
run: echo "semantic_version=$(cat docker/service_version.txt)" >> $GITHUB_ENV
Expand Down
4 changes: 1 addition & 3 deletions .github/workflows/run_tests.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,9 +16,7 @@ jobs:

steps:
- name: Checkout harmony-opendap-subsetter repository
uses: actions/checkout@v3
with:
lfs: true
uses: actions/checkout@v5

- name: Build service image
run: ./bin/build-image
Expand Down
75 changes: 41 additions & 34 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,75 +1,71 @@
## v1.1.10
### 2025-08-21
## [vX.Y.Z] - Unreleased

### Changed

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

## [v1.1.10] - 2025-08-21

This version of HOSS updates the conda environment to support Python 3.12. This also updates the
dependent packages to their latest supportable versions and updates Harmony Service Library version.

## v1.1.9
### 2025-08-13
## [v1.1.9] - 2025-08-13

This version of HOSS updates fixes invalid output extents in cases where the
requested bounding area (bbox, shape) extends beyond valid locations for the native
projection of the data. E.g., EASE-GRID-2 North Polar (LAEA) projection becomes INF
at latitude -90°.

## v1.1.8
### 2025-05-23
## [v1.1.8] - 2025-05-23

This version of HOSS updates the hoss configuration file to include
Ancillary_Data group in SPL3FTA collection metadata overrides for dimension
variables in that group.

## v1.1.7
### 2025-05-21
## [v1.1.7] - 2025-05-21

This version of HOSS updates the hoss configuration file to include
EASE_column_index and EASE_row_index as ancillary variables for the SPL2SMAP_S
collection.

## v1.1.6
### 2025-02-24
## [v1.1.6] - 2025-02-24

This version of HOSS adds support for multiple coordinate variables that
are in the same group for cases where coordinates are used in place of
dimensions. This also supports exclusive requests of coordinate
datasets that do not have coordinate attributes or dimensions.

## v1.1.5
### 2025-02-14
## [v1.1.5] - 2025-02-14

This version of HOSS adds support for 3D variables which
do not have the nominal order. This would provide support
for the 3D variables in SMAP - SPL3SMP with dimension order
information provided in the configurations file.

## v1.1.4
### 2025-02-12
## [v1.1.4] - 2025-02-12

This version of HOSS adds support for SMAP L3 polar variables that are unable to have their
dimension scale arrays created from their corresponding lat/lon variables. A 'master geotransform'
attribute has been added to the grid mapping reference variable for the affected collections
and function updates were made to create the dimension arrays from the master geotransform
when it is present.

## v1.1.3
### 2025-01-29
## [v1.1.3] - 2025-01-29

This version of HOSS supports configuration updates to hoss_config.json to
add dimension configurations for 3D variables. Functions were updated to provide the
ability to spatial subset 3D variables for products like SMAP L3 which did
not have dimension arrays.

## v1.1.2
### 2025-01-20
## [v1.1.2] - 2025-01-20

- [[DAS-2256](https://bugs.earthdata.nasa.gov/browse/DAS-2256)]
HOSS has been updated to use `earthdata-varinfo` version 3.0.1.
Please see the
[earthdata-varinfo release notes](https://github.com/nasa/earthdata-varinfo/releases/tag/3.0.1)
for more information.

## v1.1.1
### 2025-01-14
## [v1.1.1] - 2025-01-14

This version of HOSS merges the feature branch that contains V1.1.0 to the main branch.
Additional updates included code quality improvements with additional unit tests, revised methodology
Expand All @@ -79,8 +75,7 @@ V1.1.1 and V1.1.0 are entirely to support SMAP L3 data - in particular SPL2SMAP_
all of which have “anonymous” dimensions (without dimension names and dimension variables). No functional
updates are present, nor changes that effect existing collection support.

## v1.1.0
### 2024-11-25
## [v1.1.0] - 2024-11-25

This version of HOSS provides support for gridded products that do not contain
CF-Convention compliant grid mapping variables and 1-D dimension variables, such
Expand All @@ -96,31 +91,27 @@ the cache-name for coordinates already processed for dimension ranges.
Several new functions related to this implementation have been added to
a new module `coordinate_utilities.py`.

## v1.0.5
### 2024-08-19
## [v1.0.5] - 2024-08-19

This version of HOSS updates the `is_index_subset` method to check for empty list (in case of dimensions subset)
as well as None (for the spatial, bbox and temporal subsets). This prevents 1-D dimension variables from being
unnecessarily requested from OPeNDAP for variable subsets which needs to be done only for spatial and temporal
subsetting requests. This also prevents a whole granule request when 1-D dimension variables were not present
in the granule.

## v1.0.4
### 2024-04-05
## [v1.0.4] - 2024-04-05

This version of HOSS implements `black` code formatting across the repository.
There should be no functional changes in the service.

## v1.0.3
### 2024-03-29
## [v1.0.3] - 2024-03-29

This version of HOSS handles the error in the crs_wkt attribute in ATL19 where the
north polar crs variable has a leading iquotation mark escaped by back slash in the
crs_wkt attribute. This causes errors when the projection is being interpreted from
the crs variable attributes.

## v1.0.2
### 2024-02-26
## [v1.0.2] - 2024-02-26

This version of HOSS correctly handles edge-aligned geographic collections by
adding the attribute `cell_alignment` with the value `edge` to `hoss_config.json`
Expand All @@ -135,15 +126,13 @@ issue with the ATL16 metadata for the variables `/spolar_asr_obs_grid` and
to north polar variables instead of south polar variables. This CF Override
can be removed if/when the metadata is corrected.

## v1.0.1
### 2023-12-19
## [v1.0.1] - 2023-12-19

This version of HOSS removes custom, redundant download retry logic. Instead
retries are relied upon from `harmony-service-lib` and for each stage in a
Harmony workflow.

## v1.0.0
### 2023-10-06
## [v1.0.0] - 2023-10-06

This version of the Harmony OPeNDAP SubSetter (HOSS) contains all functionality
previously released internally to EOSDIS as `sds/variable-subsetter:0.3.6`.
Expand All @@ -161,3 +150,21 @@ Repository structure changes include:

For more information on internal releases prior to NASA open-source approval,
see legacy-CHANGELOG.md.

[v1.1.10]: https://github.com/nasa/harmony-opendap-subsetter/releases/tag/1.1.10
[v1.1.9]: https://github.com/nasa/harmony-opendap-subsetter/releases/tag/1.1.9
[v1.1.8]: https://github.com/nasa/harmony-opendap-subsetter/releases/tag/1.1.8
[v1.1.7]: https://github.com/nasa/harmony-opendap-subsetter/releases/tag/1.1.7
[v1.1.6]: https://github.com/nasa/harmony-opendap-subsetter/releases/tag/1.1.6
[v1.1.5]: https://github.com/nasa/harmony-opendap-subsetter/releases/tag/1.1.5
[v1.1.4]: https://github.com/nasa/harmony-opendap-subsetter/releases/tag/1.1.4
[v1.1.3]: https://github.com/nasa/harmony-opendap-subsetter/releases/tag/1.1.3
[v1.1.2]: https://github.com/nasa/harmony-opendap-subsetter/releases/tag/1.1.2
[v1.1.1]: https://github.com/nasa/harmony-opendap-subsetter/releases/tag/1.1.1
[v1.1.0]: https://github.com/nasa/harmony-opendap-subsetter/releases/tag/1.1.0
[v1.0.5]: https://github.com/nasa/harmony-opendap-subsetter/releases/tag/1.0.5
[v1.0.4]: https://github.com/nasa/harmony-opendap-subsetter/releases/tag/1.0.4
[v1.0.3]: https://github.com/nasa/harmony-opendap-subsetter/releases/tag/1.0.3
[v1.0.2]: https://github.com/nasa/harmony-opendap-subsetter/releases/tag/1.0.2
[v1.0.1]: https://github.com/nasa/harmony-opendap-subsetter/releases/tag/1.0.1
[v1.0.0]: https://github.com/nasa/harmony-opendap-subsetter/releases/tag/1.0.0
41 changes: 35 additions & 6 deletions bin/extract-release-notes.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,17 +6,46 @@
#
# 2023-06-16: Created.
# 2023-10-10: Copied from earthdata-varinfo repository to HOSS.
# 2025-09-22: Append git commit messages to release notes.
#
###############################################################################

CHANGELOG_FILE="CHANGELOG.md"
VERSION_PATTERN="^## v"
# Count number of versions in version file:
number_of_versions=$(grep -c "${VERSION_PATTERN}" ${CHANGELOG_FILE})

if [ ${number_of_versions} -gt 1 ]
## captures versions
## >## v1.0.0
## >## [v1.0.0]
VERSION_PATTERN="^## [\[]v"

## captures url links
## [v1.2.0]: https://github.com/nasa/harmony-opendap-subsetter/releases/tags/1.2.0
LINK_PATTERN="^\[.*\]:.*https://github.com/nasa"

# Read the file and extract text between the first two occurrences of the
# VERSION_PATTERN
result=$(awk "/$VERSION_PATTERN/{c++; if(c==2) exit;} c==1" "$CHANGELOG_FILE")

# Get all commit messages since the last release (marked with a git tag). If
# there are no tags, get the full commit history of the repository.
if [[ $(git tag) ]]
then
grep -B 9999 -m 2 "${VERSION_PATTERN}" ${CHANGELOG_FILE} | sed '$d' | sed '$d'
# There are git tags, so get the most recent one
GIT_REF=$(git describe --tags --abbrev=0)
else
cat ${CHANGELOG_FILE}
# There are not git tags, so get the initial commit of the repository
GIT_REF=$(git rev-list --max-parents=0 HEAD)
fi

# Retrieve the title line of all commit messages since $GIT_REF, filtering out
# those from the pre-commit-ci[bot] author and any containing the string
# "nasa/pre-commit-ci-update-config", which may result from merge commits.
GIT_COMMIT_MESSAGES=$(git log --oneline --format="%s" --perl-regexp --author='^(?!pre-commit-ci\[bot\]).*$' --grep="nasa\/pre-commit-ci-update-config" --invert-grep ${GIT_REF}..HEAD)

# Append git commit messages to the release notes:
if [[ ${GIT_COMMIT_MESSAGES} ]]
then
result+="\n\n## Commits\n\n${GIT_COMMIT_MESSAGES}"
fi

# Print the result
echo -e "$result" | grep -v "$VERSION_PATTERN" | grep -v "$LINK_PATTERN"