From d9f87a57215969095deaa0c3631b34f1752854c1 Mon Sep 17 00:00:00 2001 From: Antonio Vivace Date: Tue, 29 Oct 2024 00:43:48 +0100 Subject: [PATCH] contributing: add paragraph regarding the container image --- CONTRIBUTING.md | 14 ++++++++++++++ 1 file changed, 14 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 3afed53b1..654e0c72b 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -174,3 +174,17 @@ Each one is a binary RNG file which is passed to the `rgbgfx_test` program. ```sh test_downstream ``` + +## 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 +``` \ No newline at end of file