Skip to content

feat(docker): Generate unique tag for each clp-package dev image build to avoid conflicts on shared hosts. #1335

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 17 commits into from
Sep 30, 2025
Merged

feat(docker): Generate unique tag for each clp-package dev image build to avoid conflicts on shared hosts. #1335

Show file tree
Hide file tree
Changes from 13 commits
Commits
Show all changes
17 commits
Select commit Hold shift + click to select a range
653cdd7
feat(docker): Generate unique identifier for each clp-package dev ima…
junhaoliao Sep 25, 2025
0c8c699
update inline doc about image reuse for clarity
junhaoliao Sep 25, 2025
d79cb5f
refactor(docker): update clp-package build script to modify image ID …
junhaoliao Sep 26, 2025
49f3822
Merge branch 'main' into package-image-id
junhaoliao Sep 26, 2025
e0dc40f
Use `<` operator instead of `cat` for reading file - Apply suggestion…
junhaoliao Sep 26, 2025
ec09d98
Add period in removing image prompt - Apply suggestions from code review
junhaoliao Sep 26, 2025
a2a8f08
move remove_prev_image() to the top
junhaoliao Sep 26, 2025
7a05377
Remove the command that copies the image id into the package - Apply …
junhaoliao Sep 29, 2025
be5a517
refactor(docker): Improve clp-package image cleanup and tagging logic.
junhaoliao Sep 29, 2025
0e2667c
Merge branch 'main' into package-image-id
junhaoliao Sep 29, 2025
aa4919f
rename remove_prev_image -> remove_prev_image_and_temp_file; move rem…
junhaoliao Sep 29, 2025
94a8523
Merge branch 'main' into package-image-id
junhaoliao Sep 30, 2025
c9d9959
docs: add docker version requirements into the dev docs.
junhaoliao Sep 30, 2025
074650c
refactor(docker): Use fallback user variable for dev image tagging.
junhaoliao Sep 30, 2025
2b73559
reformat
junhaoliao Sep 30, 2025
fba7d3b
rename remove_prev_image_and_temp_file -> remove_temp_file_and_prev_i…
junhaoliao Sep 30, 2025
c778427
revert spaces
junhaoliao Sep 30, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions docs/src/dev-docs/building-package.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,11 @@ prebuilt version instead, check out the [releases](https://github.com/y-scope/cl
environment.
* It should be possible to build a package for a different environment, it just requires a some
extra configuration.
* [Docker]
* `containerd.io` >= 1.7.18
* `docker-buildx-plugin` >= 0.15.1
* `docker-ce` >= 27.0.3
* `docker-ce-cli` >= 27.0.3
* Python 3.9 or newer
* python3-dev
* python3-venv (for the version of Python installed)
Expand Down Expand Up @@ -80,6 +85,7 @@ task docker-images:package

This will create a Docker image named `clp-package:dev`.
Copy link
Contributor

@coderabbitai coderabbitai bot Sep 30, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue | 🟠 Major

Update documentation to reflect the new image tagging scheme.

According to the PR summary, the build process now generates unique identifiers to avoid overwriting older builds on shared machines. The AI summary mentions tagging as clp-package:dev-${USER}-${short_id}, but this line still states the image will be named clp-package:dev.

Please update this documentation to:

  1. Explain that each build generates a unique image identifier
  2. Clarify how users can reference the built image (e.g., via the image.id file mentioned in the PR summary)
  3. Optionally, mention the tagging convention if it's relevant for users
🤖 Prompt for AI Agents 
In docs/src/dev-docs/building-package.md around line 86, the text still claims
the Docker image will be named `clp-package:dev` but the build now generates
unique image identifiers; update this line to state that each build produces a
uniquely tagged image to avoid overwrites, note where to find the exact image
reference (point to the generated image.id file created by the build), and
optionally show the tagging convention used (e.g.,
clp-package:dev-${USER}-${short_id}) so users know how to reference the image or
read image.id for the precise tag.


[Docker]: https://docs.docker.com/engine/install/
[Task]: https://taskfile.dev/
[uv]: https://docs.astral.sh/uv/
[y-scope/clp#1352]: https://github.com/y-scope/clp/issues/1352
31 changes: 30 additions & 1 deletion tools/docker-images/clp-package/build.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,12 +3,32 @@
set -eu
set -o pipefail

remove_prev_image_and_temp_file() {
if [[ -n "$prev_image_id" && "$prev_image_id" != "$new_image_id" ]]; then
if docker image inspect "$prev_image_id" >/dev/null 2>&1; then
echo "Removing previous image $prev_image_id."
docker image remove "$prev_image_id"
fi
fi
rm -f "$temp_iid_file"
}
trap remove_prev_image_and_temp_file EXIT

script_dir="$( cd "$( dirname "${BASH_SOURCE[0]}" )" &> /dev/null && pwd )"
repo_root=${script_dir}/../../../
iid_file="${repo_root}/build/clp-package-image.id"

prev_image_id=""
if [[ -f "$iid_file" ]]; then
prev_image_id=$(<"$iid_file")
fi

temp_iid_file="$(mktemp)"
new_image_id=""

build_cmd=(
docker build
--tag "clp-package:dev"
--iidfile "$temp_iid_file"
"$repo_root"
--file "${script_dir}/Dockerfile"
)
Expand All @@ -22,3 +42,12 @@ then
fi

"${build_cmd[@]}"

if [[ -s "$temp_iid_file" ]]; then
new_image_id=$(<"$temp_iid_file")
echo "$new_image_id" > "$iid_file"

short_id=${new_image_id#sha256:}
short_id=${short_id:0:4}
docker tag "$new_image_id" "clp-package:dev-${USER}-${short_id}"
fi
Loading