Skip to content

Commit

Permalink
FIXUP: Explain why image caching is bad for release artifacts
Browse files Browse the repository at this point in the history
  • Loading branch information
apyrgio committed Dec 10, 2024
1 parent 012438a commit 340cc7d
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 1 deletion.
7 changes: 7 additions & 0 deletions docs/developer/doit.md
Original file line number Diff line number Diff line change
Expand Up @@ -51,6 +51,13 @@ doit <task>
use_cache = true
```

> [!WARNING]
> Using caching may speed up image builds, but is not suitable for release
> artifacts. The ID of our base container image (Alpine Linux) does not change
> that often, but its APK package index does. So, if we use caching, we risk
> skipping the `apk upgrade` layer and end up with packages that are days
> behind.
* You can pass the following environment variables to the script, in order to
affect some global parameters:
- `CONTAINER_RUNTIME`: The container runtime to use. Either `podman` (default)
Expand Down
3 changes: 2 additions & 1 deletion pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -71,7 +71,8 @@ follow_links = false
verbosity = 3

[tool.doit.tasks.build_image]
# DO NOT change this to 'true' for release artifacts.
# DO NOT change this to 'true' for release artifacts, else we risk building
# images that are a few days behind. See also: docs/developer/doit.md
use_cache = false

[build-system]
Expand Down

0 comments on commit 340cc7d

Please sign in to comment.