Skip to content

Commit

Permalink
contributing: add paragraph regarding the container image
Browse files Browse the repository at this point in the history
  • Loading branch information
avivace committed Oct 28, 2024
1 parent a7fdb2c commit d9f87a5
Showing 1 changed file with 14 additions and 0 deletions.
14 changes: 14 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -174,3 +174,17 @@ Each one is a binary RNG file which is passed to the `rgbgfx_test` program.
```sh
test_downstream <owner> <repo> <makefile target> <build file> <sha1 hash of build file>
```

## Container images

The CI will [take care](https://github.com/gbdev/rgbds/blob/master/.github/workflows/build-container.yml) of updating the [rgbds container](https://github.com/gbdev/rgbds/pkgs/container/rgbds) image tagged `master`.

When a git tag is pushed, the image is also tagged with that tag.

The image can be built locally and pushed to the GitHub container registry by manually running:

```bash
# e.g. to build and tag as 'master'
docker build . --tag ghcr.io/gbdev/rgbds:master
docker push ghcr.io/gbdev/rgbds:master
```

0 comments on commit d9f87a5

Please sign in to comment.