Skip to content

Commit 6c65bf4

Browse files
committed
add notes for usage of rolling tags vs. fixed versions
1 parent f16c232 commit 6c65bf4

File tree

1 file changed

+22
-0
lines changed

1 file changed

+22
-0
lines changed

README.md

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -208,6 +208,28 @@ You might use this container image in the `.devcontainer/devcontainer.json` file
208208
}
209209
```
210210

211+
### Notes for usage in CI/CD pipelines and .devcontainer configs
212+
213+
When using an `image_version` with a rolling tag (e.g., "trixie-latest"),
214+
the build will always use the most recent version of that image.
215+
As a result, included software may change over time, which can introduce
216+
unexpected build failures (for example, due to compiler version updates).
217+
218+
To ensure stability and reproducibility, it is recommended to pin
219+
`image_version` to a fixed release (e.g., "trixie-20260329") if
220+
bleeding-edge updates are not required.
221+
222+
You might want to annotate your `image_version` section with the following
223+
comment to clarify the implications of using rolling tags vs. fixed versions:
224+
225+
```
226+
# Note on "image_version":
227+
# The image versions are based on tags of the https://github.com/jakoch/cpp-devbox repo.
228+
# Use rolling tags (e.g., "trixie-latest") for bleeding-edge updates,
229+
# but expect potential instability due to changes in the included software.
230+
# Pin to a fixed version (e.g., "trixie-20260329") for reproducible and stable builds.
231+
```
232+
211233
#### Developer Notes
212234

213235
### Versioning Scheme for Images

0 commit comments

Comments
 (0)