Skip to content

Commit b3ceb03

Browse files
authored
Describe custom arguments and add links for docker build args and GitHub env variables (#2153)
1 parent aa90bc8 commit b3ceb03

File tree

1 file changed

+12
-5
lines changed

1 file changed

+12
-5
lines changed

docs/using/custom-images.md

Lines changed: 12 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -13,11 +13,18 @@ please, [take a look at cookiecutter template](../contributing/stacks.md).
1313

1414
## Custom arguments
1515

16-
Existing customization points:
17-
18-
- `ROOT_CONTAINER`, `PYTHON_VERSION` - docker arguments of a `docker-stacks-foundation` image
19-
- `REGISTRY`, `OWNER`, `BASE_CONTAINER` - docker arguments for all the other images we build
20-
- `REGISTRY`, `OWNER` - part of `env` in most of our GitHub workflows
16+
Our repository provides several customization points:
17+
18+
- `ROOT_CONTAINER` (docker argument) - the parent image for `docker-stacks-foundation` image
19+
- `PYTHON_VERSION` (docker argument) - the Python version to install in `docker-stacks-foundation` image
20+
- `REGISTRY`, `OWNER`, `BASE_CONTAINER` (docker arguments) - they allow to specify parent image for all the other images
21+
- `REGISTRY`, `OWNER` (part of `env` in some GitHub workflows) - these allow to properly tag and refer to images during following steps:
22+
[`build-test-upload`](https://github.com/jupyter/docker-stacks/blob/main/.github/workflows/docker-build-test-upload.yml),
23+
[`tag-push`](https://github.com/jupyter/docker-stacks/blob/main/.github/workflows/docker-tag-push.yml) and
24+
[`merge-tags`](https://github.com/jupyter/docker-stacks/blob/main/.github/workflows/docker-merge-tags.yml)
25+
26+
These customization points can't be changed during runtime.
27+
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).
2128

2229
## Building stack images with custom arguments
2330

0 commit comments

Comments
 (0)