Add a version in the image tag

so we can change the interface used to communicate with the
container.
Using an image tag allows to automatically download the expected image on
the developer's computer in case of update.

In the future, if we distribute tagged versions of xcp-ng-dev (on pypi for
example), we might want to use that version instead.

Signed-off-by: Gaëtan Lehmann <gaetan.lehmann@vates.tech>

Author: glehmann

.github/workflows/docker.yml

@@ -20,12 +20,13 @@ jobs:
           registry: ghcr.io
           username: ${{ github.actor }} # Uses the GitHub user/org name that triggered the workflow
           password: ${{ secrets.GITHUB_TOKEN }} # Automatically provided by GitHub
+      - run: echo "VERSION=$(cat ./src/xcp_ng_dev/files/protocol-version.txt | tr -d '\n')" >> $GITHUB_ENV
       - uses: docker/build-push-action@v5 # Using v5 for latest features
         with:
           context: ./container
           file: ./container/Dockerfile-8.x
           push: ${{ github.ref == 'refs/heads/master' }}
-          tags: ghcr.io/${{ github.repository }}:8.2
+          tags: ghcr.io/${{ github.repository }}:8.2-${{ env.VERSION }}
           cache-from: type=gha,scope=${{ github.ref_name }}-82 # Cache layers to speed up builds
           cache-to: type=gha,mode=max,scope=${{ github.ref_name }}-82 # Store layers in cache for future builds
           build-args: |
@@ -46,12 +47,13 @@ jobs:
           registry: ghcr.io
           username: ${{ github.actor }} # Uses the GitHub user/org name that triggered the workflow
           password: ${{ secrets.GITHUB_TOKEN }} # Automatically provided by GitHub
+      - run: echo "VERSION=$(cat ./src/xcp_ng_dev/files/protocol-version.txt | tr -d '\n')" >> $GITHUB_ENV
       - uses: docker/build-push-action@v5 # Using v5 for latest features
         with:
           context: ./container
           file: ./container/Dockerfile-8.x
           push: ${{ github.ref == 'refs/heads/master' }}
-          tags: ghcr.io/${{ github.repository }}:8.3
+          tags: ghcr.io/${{ github.repository }}:8.3-${{ env.VERSION }}
           cache-from: type=gha,scope=${{ github.ref_name }}-83 # Cache layers to speed up builds
           cache-to: type=gha,mode=max,scope=${{ github.ref_name }}-83 # Store layers in cache for future builds
           platforms: |
@@ -71,13 +73,14 @@ jobs:
   #         registry: ghcr.io
   #         username: ${{ github.actor }} # Uses the GitHub user/org name that triggered the workflow
   #         password: ${{ secrets.GITHUB_TOKEN }} # Automatically provided by GitHub
+  #     - run: echo "VERSION=$(cat ./src/xcp_ng_dev/files/protocol-version.txt | tr -d '\n')" >> $GITHUB_ENV
   #     - uses: docker/build-push-action@v5 # Using v5 for latest features
   #       with:
   #         context: ./container
   #         file: ./container/Dockerfile-9.x
   #         platforms: |
   #           linux/amd64/v2
   #         push: ${{ github.ref == 'refs/heads/master' }}
-  #         tags: ghcr.io/${{ github.repository }}:9.0
+  #         tags: ghcr.io/${{ github.repository }}:9.0-${{ env.VERSION }}
   #         cache-from: type=gha,scope=${{ github.ref_name }}-90 # Cache layers to speed up builds
   #         cache-to: type=gha,mode=max,scope=${{ github.ref_name }}-90 # Store layers in cache for future builds

container/build.sh

@@ -85,9 +85,12 @@ case "$1" in
         ;;
 esac
 
+version_data=$(cat ../src/xcp_ng_dev/files/protocol-version.txt)
+version=$(echo "$version_data" | tr -d '\n')
+
 "$RUNNER" build \
     --platform "$PLATFORM" \
-    -t ghcr.io/xcp-ng/xcp-ng-build-env:${1} \
+    -t ghcr.io/xcp-ng/xcp-ng-build-env:${1}-${version} \
     --build-arg XCP_NG_BRANCH=${1} \
     --ulimit nofile=1024 \
     -f $DOCKERFILE .

src/xcp_ng_dev/cli.py

@@ -13,6 +13,8 @@
 import subprocess
 import shutil
 import sys
+from pathlib import Path
+
 import argcomplete
 
 CONTAINER_PREFIX = "ghcr.io/xcp-ng/xcp-ng-build-env"
@@ -37,6 +39,10 @@ def is_podman(runner):
         return True
     return False
 
+def read_version():
+    with open(Path(__file__).parent / 'files/protocol-version.txt') as f:
+        return f.read().strip()
+
 def add_common_args(parser):
     group = parser.add_argument_group("common arguments")
     group.add_argument('-n', '--no-exit', action='store_true',
@@ -235,7 +241,7 @@ def container(args):
             pass
 
     # exec "docker run"
-    docker_args += [f"{CONTAINER_PREFIX}:{args.container_version}",
+    docker_args += [f"{CONTAINER_PREFIX}:{args.container_version}-{read_version()}",
                     "/usr/local/bin/init-container.sh"]
     print("Launching docker with args %s" % docker_args, file=sys.stderr)
     return subprocess.call(docker_args)

src/xcp_ng_dev/files/protocol-version.txt

@@ -0,0 +1 @@
+1