Skip to content
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

DAS-2070 - Update README to describe new CI/CD. #2

Merged
merged 1 commit into from
Feb 7, 2024
Merged

DAS-2070 - Update README to describe new CI/CD. #2

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
16 changes: 10 additions & 6 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,8 +30,8 @@ Global Image Browse Services ([GIBS](https://www.earthdata.nasa.gov/eosdis/scien
HyBIG, including recommended git best practices.
* `README.md` - This file, containing guidance on developing the service.
* `bin` - A directory containing utility scripts to build the service and test
images. This also includes scripts that Bamboo uses to deploy new service
images to AWS ECR.
images. A script to extract the release notes for the most recent service
version, as contained in `CHANGELOG.md` is also in this directory.
* `conda_requirements.txt` - A list of service dependencies, such as GDAL, that
cannot be installed via Pip.
* `dev-requirements.txt` - list of packages required for service development.
Expand Down Expand Up @@ -85,10 +85,14 @@ $ ./bin/run-test
The `tests/run_tests.sh` script will also generate a coverage report, rendered
in HTML, and scan the code with `pylint`.

Currently, the `unittest` suite is run automatically within Bamboo as part of a
CI/CD pipeline. In future, this project will be migrated from Bitbucket to
GitHub, at which point the CI/CD will be migrated to workflows that use GitHub
Actions.
Currently, the `unittest` suite is run automatically within a GitHub workflow
as part of a CI/CD pipeline. These tests are run for all changes made in a PR
against the `main` branch. The tests must pass in order to merge the PR.

The unit tests are also run prior to publication of a new Docker image, when
commits including changes to `docker/service_version.txt` are merged into the
`main` branch. If these unit tests fail, the new version of the Docker image
will not be published.

## Versioning:

Expand Down
Loading