Skip to content

Commit

Permalink
Describe custom arguments and add links for docker build args and Git…
Browse files Browse the repository at this point in the history
…Hub env variables (#2153)
  • Loading branch information
mathbunnyru authored Oct 9, 2024
1 parent aa90bc8 commit b3ceb03
Showing 1 changed file with 12 additions and 5 deletions.
17 changes: 12 additions & 5 deletions docs/using/custom-images.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,11 +13,18 @@ please, [take a look at cookiecutter template](../contributing/stacks.md).

## Custom arguments

Existing customization points:

- `ROOT_CONTAINER`, `PYTHON_VERSION` - docker arguments of a `docker-stacks-foundation` image
- `REGISTRY`, `OWNER`, `BASE_CONTAINER` - docker arguments for all the other images we build
- `REGISTRY`, `OWNER` - part of `env` in most of our GitHub workflows
Our repository provides several customization points:

- `ROOT_CONTAINER` (docker argument) - the parent image for `docker-stacks-foundation` image
- `PYTHON_VERSION` (docker argument) - the Python version to install in `docker-stacks-foundation` image
- `REGISTRY`, `OWNER`, `BASE_CONTAINER` (docker arguments) - they allow to specify parent image for all the other images
- `REGISTRY`, `OWNER` (part of `env` in some GitHub workflows) - these allow to properly tag and refer to images during following steps:
[`build-test-upload`](https://github.com/jupyter/docker-stacks/blob/main/.github/workflows/docker-build-test-upload.yml),
[`tag-push`](https://github.com/jupyter/docker-stacks/blob/main/.github/workflows/docker-tag-push.yml) and
[`merge-tags`](https://github.com/jupyter/docker-stacks/blob/main/.github/workflows/docker-merge-tags.yml)

These customization points can't be changed during runtime.
Read more about [Docker build arguments](https://docs.docker.com/build/building/variables/#arg-usage-example) and [GitHub environment variables for a single workflow](https://docs.github.com/en/actions/writing-workflows/choosing-what-your-workflow-does/store-information-in-variables#defining-environment-variables-for-a-single-workflow).

## Building stack images with custom arguments

Expand Down

0 comments on commit b3ceb03

Please sign in to comment.