DAS-2255: rename service consistently. (#7)

nasa · Dec 3, 2024 · c019441 · c019441
1 parent 0418041
commit c019441
Show file tree

Hide file tree

Showing 16 changed files with 37 additions and 31 deletions.
diff --git a/.github/workflows/publish_release.yml b/.github/workflows/publish_release.yml
@@ -41,7 +41,7 @@ jobs:
       fail-fast: false
 
     steps:
-      - name: Checkout smap-l2-gridder repository
+      - name: Checkout harmony-smap-l2-gridding-service repository
         uses: actions/checkout@v4
         with:
           lfs: true

diff --git a/.github/workflows/run_lib_tests.yml b/.github/workflows/run_lib_tests.yml
@@ -13,7 +13,7 @@ jobs:
         python-version: ['3.10', '3.11', '3.12']
 
     steps:
-      - name: Checkout smap-l2-gridder repository
+      - name: Checkout harmony-smap-l2-gridding-service repository
         uses: actions/checkout@v4
         with:
           lfs: true

diff --git a/.github/workflows/run_service_tests.yml b/.github/workflows/run_service_tests.yml
@@ -1,4 +1,4 @@
-# This workflow will build the service and test Docker images for smap-l2-gridder,
+# This workflow will build the service and test Docker images for harmony-smap-l2-gridding-service,
 # then run the `pytest` suite within a test Docker container, reporting
 # test results and code coverage as artefacts. It will be called by the
 # workflow that run tests against new PRs and as a first step in the workflow
@@ -16,7 +16,7 @@ jobs:
       fail-fast: false
 
     steps:
-      - name: Checkout smap-l2-gridder repository
+      - name: Checkout harmony-smap-l2-gridding-service repository
         uses: actions/checkout@v4
         with:
           lfs: true

diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -5,13 +5,19 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [v0.0.2] - 2024-12-03
+
+### Changed
+
+- Docker images now use full repository name [#7](https://github.com/nasa/harmony-SMAP-L2-gridding-service/pull/7)
+
 ## [v0.0.1] - 2024-11-27
 
 ### Added
 
-- Initial codebase that transforms SPL2SMP_E granules into NetCDF4-CF grids. [#1](https://github.com/nasa/harmony-SMAP-L2-gridding-service/pull/1)
+- Initial codebase that transforms SPL2SMP_E granules into NetCDF4-CF grids [#1](https://github.com/nasa/harmony-SMAP-L2-gridding-service/pull/1)
 - Code and configuration to wrap gridding logic into a Harmony Service [#3](https://github.com/nasa/harmony-SMAP-L2-gridding-service/pull/3 )
 - GitHub actions CI configuration [#4](https://github.com/nasa/harmony-SMAP-L2-gridding-service/pull/4 )
 
-
+[v0.0.2]: https://github.com/nasa/harmony-SMAP-L2-gridding-service/releases/tag/0.0.2
 [v0.0.1]: https://github.com/nasa/harmony-SMAP-L2-gridding-service/releases/tag/0.0.1
diff --git a/bin/build-image b/bin/build-image
@@ -1,11 +1,11 @@
 #!/bin/bash
 ###############################################################################
 #
-# Build a Docker image of the Harmony-SMAP-L2-Gridder service.
+# Build a Docker image of the HARMONY SMAP L2 Gridding Service
 #
 ###############################################################################
 
-image="ghcr.io/nasa/harmony-smap-l2-gridder"
+image="ghcr.io/nasa/harmony-smap-l2-gridding-service"
 
 # Retrieve the tag from the script arguments, or default to "latest". Bamboo
 # will pass the contents of `docker/service_version.txt` as this argument,
@@ -14,8 +14,8 @@ image="ghcr.io/nasa/harmony-smap-l2-gridder"
 tag=${1:-latest}
 
 
-# Remove old versions of: ghcr.io/nasa/harmony-smap-l2-gridder and
-# ghcr.io/nasa/harmony-smap-l2-gridder-test images
+# Remove old versions of: ghcr.io/nasa/harmony-smap-l2-gridding-service and
+# ghcr.io/nasa/harmony-smap-l2-gridding-service-test images
 ./bin/clean-images
 
 # Build the image

diff --git a/bin/build-test b/bin/build-test
@@ -3,13 +3,13 @@
 #
 # Build a Docker container to run the test suite for the SMAP-L2-Gridding-Service
 #
-# To build the ghcr.io/nasa/harmony-smap-l2-gridder-test image, the
-# ghcr.io/nasa/harmony-smap-l2-gridder image must also be present
+# To build the ghcr.io/nasa/harmony-smap-l2-gridding-service-test image, the
+# ghcr.io/nasa/harmony-smap-l2-gridding-service image must also be present
 # locally, as it is used as the base image in `docker/tests.Dockerfile`.
 #
 ###############################################################################
 
-image="ghcr.io/nasa/harmony-smap-l2-gridder-test"
+image="ghcr.io/nasa/harmony-smap-l2-gridding-service-test"
 tag=${1:-latest}
 
 

diff --git a/bin/clean-images b/bin/clean-images
@@ -2,7 +2,7 @@
 ###############################################################################
 #
 # remove all images containing the string
-# "ghcr.io/nasa/harmony-smap-l2-gridder" and remove them.
+# "ghcr.io/nasa/harmony-smap-l2-gridding-service" and remove them.
 # This is used for clean-up after development.
 #
 ###############################################################################
@@ -15,7 +15,7 @@ remove_image_by_name() {
     fi
 }
 
-image_base_name="ghcr.io/nasa/harmony-smap-l2-gridder"
+image_base_name="ghcr.io/nasa/harmony-smap-l2-gridding-service"
 
 # First remove test images:
 remove_image_by_name "${image_base_name}-test"

diff --git a/bin/run-test b/bin/run-test
@@ -1,7 +1,7 @@
 #!/bin/bash
 ###############################################################################
 #
-# Execute the ghcr.io/nasa/harmony-smap-l2-gridder-test Docker image
+# Execute the ghcr.io/nasa/harmony-smap-l2-gridding-service Docker image
 #
 ###############################################################################
 
@@ -21,4 +21,4 @@ mkdir -p reports/coverage
 docker run  --rm \
 	-v $(pwd)/reports/test-reports:/home/reports/test-reports \
 	-v $(pwd)/reports/coverage:/home/reports/coverage \
-	ghcr.io/nasa/harmony-smap-l2-gridder-test "$@"
+	ghcr.io/nasa/harmony-smap-l2-gridding-service-test "$@"
diff --git a/docker/service.Dockerfile b/docker/service.Dockerfile
@@ -1,8 +1,8 @@
 ###############################################################################
 #
-# Service image for ghcr.io/nasa/harmony-smap-l2-gridder
-
-# Harmony-SMAP-L2-Gridder backend service that transforms L2G (gridded
+# Service image for ghcr.io/nasa/harmony-smap-l2-gridding-service
+#
+# Harmony-SMAP-L2-Gridding-Service backend that transforms L2G (gridded
 # trajectory) data into actual gridded data.
 #
 # This image installs dependencies via Pip. The service code is then copied

diff --git a/docker/service_version.txt b/docker/service_version.txt
@@ -1 +1 @@
-0.0.1
+0.0.2
diff --git a/docker/tests.Dockerfile b/docker/tests.Dockerfile
@@ -1,11 +1,11 @@
 ###############################################################################
 #
-# Test image for the SMAP-L2-Gridding-Service. This test image uses the main
-# service image as a base layer for the tests. This ensures that the contents
-# of the service image are tested, preventing discrepancies between the service
-# and test environments.
+# Test image for the Harmony-SMAP-L2-Gridding-Service. This test image uses the
+# main service image as a base layer for the tests. This ensures that the
+# contents of the service image are tested, preventing discrepancies between
+# the service and test environments.
 ###############################################################################
-FROM ghcr.io/nasa/harmony-smap-l2-gridder
+FROM ghcr.io/nasa/harmony-smap-l2-gridding-service
 
 # Install additional Pip requirements (for testing)
 COPY tests/pip_test_requirements.txt .

diff --git a/harmony_service/__main__.py b/harmony_service/__main__.py
@@ -1,4 +1,4 @@
-"""Run the Harmony-SMAP-L2-Gridder via the Harmony CLI."""
+"""Run the Harmony-SMAP-L2-Gridding-Service via the Harmony CLI."""
 
 from argparse import ArgumentParser
 from sys import argv

diff --git a/harmony_service/adapter.py b/harmony_service/adapter.py
@@ -20,7 +20,7 @@
 
 
 class SMAPL2GridderAdapter(BaseHarmonyAdapter):
-    """Custom adapter for Harmony-SMAP-L2-Gridder Service."""
+    """Custom adapter for Harmony SMAP L2 Gridding Service."""
 
     def process_item(self, item: Item, source: HarmonySource) -> Item:
         """Process single input STAC item."""

diff --git a/harmony_service/exceptions.py b/harmony_service/exceptions.py
@@ -2,7 +2,7 @@
 
 from harmony_service_lib.util import HarmonyException
 
-SERVICE_NAME = 'Harmony-SMAP-L2-Gridder'
+SERVICE_NAME = 'harmony-smap-l2-gridding-service'
 
 
 class SMAPL2GridderServiceError(HarmonyException):

diff --git a/smap_l2_gridder/__init__.py b/smap_l2_gridder/__init__.py
@@ -1 +1 @@
-"""Initialize the Harmony-SMAP-L2-Gridder package."""
+"""Initialize the Harmony SMAP L2 Gridding Service package."""
diff --git a/smap_l2_gridder/exceptions.py b/smap_l2_gridder/exceptions.py
@@ -5,7 +5,7 @@ class SMAPL2GridderError(Exception):
     """Base error class for exceptions raised by smap_l2_gridder library."""
 
     def __init__(self, message=None):
-        """All Harmony-SMAP-L2-Gridder errors have a message field."""
+        """All Harmony-SMAP-L2-Gridding-Service errors have a message field."""
         self.message = message
Original file line number	Diff line number	Diff line change
		@@ -1 +1 @@
		"""Initialize the Harmony-SMAP-L2-Gridder package."""
		"""Initialize the Harmony SMAP L2 Gridding Service package."""