Publish debug container only if requested

Author: Ware, Joseph (DLSLtd,RAL,LSCI)

.github/workflows/_container.yml

@@ -50,26 +50,6 @@ jobs:
             type=ref,event=tag
             type=raw,value=latest
 
-      - name: Create tags for publishing debug image
-        id: debug-meta
-        uses: docker/metadata-action@v5
-        with:
-          images: ghcr.io/${{ github.repository }}
-          tags: |
-            type=ref,event=tag,suffix=-debug
-            type=raw,value=latest-debug
-
-      - name: Build and publish debug image to container registry
-        if: github.ref_type == 'tag'
-        uses: docker/build-push-action@v6
-        env:
-          DOCKER_BUILD_RECORD_UPLOAD: false
-        with:
-          context: .
-          push: true
-          target: debug
-          tags: ${{ steps.debug-meta.outputs.tags }}
-
       - name: Push cached image to container registry
         if: inputs.publish && github.ref_type == 'tag'
         uses: docker/build-push-action@v6

copier.yml

@@ -103,6 +103,15 @@ docker:
         Would you like to publish your project in a Docker container?
         You should select this if you are making a service.
 
+docker_debug:
+    type: bool
+    when: "{{ docker }}"
+    help: |
+        Would you like to publish a debug image of your service?
+        This will increase the number of published images, but may
+        be useful if debugging the service inside of the cluster
+        infrastructure is required.
+
 docs_type:
     type: str
     help: |

example-answers.yml

@@ -6,6 +6,7 @@ component_lifecycle: experimental
 description: An expanded https://github.com/DiamondLightSource/python-copier-template to illustrate how it looks with all the options enabled.
 distribution_name: dls-python-copier-template-example
 docker: true
+docker_debug: true
 docs_type: sphinx
 git_platform: github.com
 github_org: DiamondLightSource

template/Dockerfile.jinja

@@ -19,6 +19,7 @@ COPY --chmod=o+wrX . /workspaces/{{ repo_name }}
 WORKDIR /workspaces/{{ repo_name }}
 RUN touch dev-requirements.txt && pip install -c dev-requirements.txt .
 
+{% if docker_debug %}
 FROM build AS debug
 
 {% if git_platform=="github.com" %}
@@ -39,6 +40,7 @@ RUN pip install -e .
 ENTRYPOINT [ "/bin/bash", "-c", "--" ]
 CMD [ "while true; do sleep 30; done;" ]
 
+{% endif %}
 # The runtime stage copies the built venv into a slim runtime container
 FROM python:${PYTHON_VERSION}-slim AS runtime
 # Add apt-get system dependecies for runtime here if needed

template/{% if git_platform=="github.com" %}.github{% endif %}/workflows/ci.yml.jinja

@@ -41,7 +41,16 @@ jobs:
     permissions:
       contents: read
       packages: write
-{% endraw %}{% endif %}{% if sphinx %}
+{% endraw %}{% if docker_debug %}{% raw %}
+  debug_container:
+    needs: [container, test]
+    uses: ./.github/workflows/_debug_container.yml
+    with:
+      publish: ${{ needs.test.result == 'success' }}
+    permissions:
+      contents: read
+      packages: write
+{% endraw %}{% endif %}{% endif %}{% if sphinx %}
   docs:
     uses: ./.github/workflows/_docs.yml
 

template/{% if git_platform=="github.com" %}.github{% endif %}/workflows/{% if docker_debug %}_debug_container.yml{% endif %}

@@ -0,0 +1,49 @@
+on:
+  workflow_call:
+    inputs:
+      publish:
+        type: boolean
+        description: If true, pushes image to container registry
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+        with:
+          # Need this to get version number from last tag
+          fetch-depth: 0
+
+      - name: Set up Docker Buildx
+        id: buildx
+        uses: docker/setup-buildx-action@v3
+
+      - name: Log in to GitHub Docker Registry
+        if: github.event_name != 'pull_request'
+        uses: docker/login-action@v3
+        with:
+          registry: ghcr.io
+          username: ${{ github.actor }}
+          password: ${{ secrets.GITHUB_TOKEN }}
+
+      - name: Create tags for publishing debug image
+        id: debug-meta
+        uses: docker/metadata-action@v5
+        with:
+          images: ghcr.io/${{ github.repository }}
+          tags: |
+            type=ref,event=tag,suffix=-debug
+            type=raw,value=latest-debug
+
+      - name: Build and publish debug image to container registry
+        if: github.ref_type == 'tag'
+        uses: docker/build-push-action@v6
+        env:
+          DOCKER_BUILD_RECORD_UPLOAD: false
+        with:
+          context: .
+          push: true
+          target: debug
+          tags: ${{ steps.debug-meta.outputs.tags }}