DAS-2070 - Implement GitHub workflows CI/CD. #1
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
Take out the elusive sds's: 
|
|
@lyonthefrog - good catches. I made some changes in the latest commit to fix most of those:
|
|
The HyBIG regression tests were successful, as were the unit tests (report below). And it appears that the Snyk checks below have passed. 
|
lyonthefrog
approved these changes
Jan 24, 2024
flamingbear
requested changes
Jan 24, 2024
README.md
Outdated
| Initially service Docker images will be hosted in AWS Elastic Container | ||
| Registry (ECR). When this repository is migrated to the NASA GitHub | ||
| organisation, service images will be published to ghcr.io, instead. | ||
| The CI/CD for HyBIG is contained in GitHub workslofws in the |
There was a problem hiding this comment.
Suggested change
| The CI/CD for HyBIG is contained in GitHub workslofws in the | |
| The CI/CD for HyBIG is contained in GitHub worksflows in the |
README.md
Outdated
| You can reach out to the maintainers of this repository via email: | ||
|
|
||
| * [email protected] | ||
| * [email protected] |
There was a problem hiding this comment.
Suggested change
| * matthew.savioe@colorado.edu | |
| * matthew.savoie@colorado.edu |
I don't love email, but I should be able to ignore it.
bin/extract-release-notes.sh
Outdated
Comment on lines
13
to
24
|
|
||
| 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 ] | ||
| then | ||
| grep -B 9999 -m 2 "${VERSION_PATTERN}" ${CHANGELOG_FILE} | sed '$d' | sed '$d' | ||
| else | ||
| cat ${CHANGELOG_FILE} | ||
| fi |
There was a problem hiding this comment.
Suggested change
| 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 ] | |
| then | |
| grep -B 9999 -m 2 "${VERSION_PATTERN}" ${CHANGELOG_FILE} | sed '$d' | sed '$d' | |
| else | |
| cat ${CHANGELOG_FILE} | |
| fi | |
| # File name | |
| CHANGELOG_FILE="CHANGELOG.md" | |
| # Regular expression | |
| VERSION_PATTERN="^## v" | |
| # 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") | |
| # Print the result | |
| echo "$result" | grep -v "^#" |
What do you think? I suppose you'd have to update the comment too.
bin/extract-release-notes.sh
Outdated
| # 2023-06-16: Created. | ||
| # 2023-10-10: Copied from earthdata-varinfo repository to HOSS. | ||
| # 2024-01-03: Copied from HOSS repository to the Swath Projector. | ||
| # 2024-01-23: Copied from Swath Projector repository to HyBIG. |
There was a problem hiding this comment.
Suggested change
| # 2024-01-23: Copied from Swath Projector repository to HyBIG. | |
| # 2024-01-23: Copied and modified from Swath Projector repository to HyBIG. |
owenlittlejohns
commented
Jan 24, 2024
There was a problem hiding this comment.
@flamingbear - I think I fixed up all the typos and adopted all the changes you suggested. Thanks for catching all that.
flamingbear
approved these changes
Jan 24, 2024
LGTM. Thanks for the updates
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
This PR implements CI/CD to run the
unittestsuite for all PRs. It also adds a Docker image publication workflow for when changes are merged into themainbranch containing an update todocker/service_version.txt.The workflows are essentially copies of those used in the HOSS and Swath Projector repositories.
Jira Issue ID
DAS-2070
Local Test Steps
It's probably good to check the
bin/build-image,bin/build-testandbin/run-testscripts all work on your local machine (given the change in image name).You can also test this all works with Harmony locally:
bin/build-image.packages/util/env-defaultsupdateHYBIG_SERVICE_QUEUE_URLSto use an image name ofghcr.io/nasa/harmony-browse-image-generator:latest. (It should just be a case of replacingsdswithghcr.io/nasa)services/harmony/env-defaultsupdate the HyBIG image:HYBIG_IMAGE=ghcr.io/nasa/harmony-browse-image-generator:latest.npm run build-all.bin/bootstrap-harmony.HARMONY_HOST_URL='http:localhost:3000'. The tests should run and complete.Things to look for on this PR itself:
PR Acceptance Checklist
CHANGELOG.mdupdated to include high level summary of PR changes.docker/service_version.txtupdated if publishing a release.Tests added/updated and passing.(No new tests needed)