Merge commit '92dc82c55ef115ced132c2e43610f5c89aad6da1' into debug-services

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

.github/actions/install_requirements/action.yml

@@ -15,7 +15,8 @@ runs:
       run: |
         PYTHON_VERSION="${{ inputs.python-version }}"
         if [ $PYTHON_VERSION == "dev" ]; then
-          PYTHON_VERSION=$(sed -n "s/ARG PYTHON_VERSION=//p" Dockerfile)
+          # python version from Dockerfile, removing potential pinned sha
+          PYTHON_VERSION=$(sed -Ene "s/ARG PYTHON_VERSION=([0-9\.]+).*/\1/p" Dockerfile)
         fi
         echo "PYTHON_VERSION=$PYTHON_VERSION" >> "$GITHUB_ENV"
       shell: bash

.github/workflows/_container.yml

@@ -1,5 +1,9 @@
 on:
   workflow_call:
+    inputs:
+      publish:
+        type: boolean
+        description: If true, pushes image to container registry
 
 jobs:
   build:
@@ -67,7 +71,7 @@ jobs:
           tags: ${{ steps.debug-meta.outputs.tags }}
 
       - name: Push cached image to container registry
-        if: github.ref_type == 'tag'
+        if: inputs.publish && github.ref_type == 'tag'
         uses: docker/build-push-action@v6
         env:
           DOCKER_BUILD_RECORD_UPLOAD: false

.github/workflows/_docs.yml

@@ -1,6 +1,7 @@
 on:
   workflow_call:
 
+
 jobs:
   build:
     runs-on: ubuntu-latest

.github/workflows/_example.yml

@@ -16,11 +16,11 @@ jobs:
 
       - name: Regenerate example
         run: |
-          pipx run copier copy --data-file example-answers.yml --trust --vcs-ref=HEAD . example
+          pipx run copier copy --data-file example-answers.yml --vcs-ref=HEAD . example
 
       - name: Rewrite copier answers
         run: |
-          sed -i 's|_src_path: .|_src_path: gh:DiamondLightSource/python-copier-template|' example/.copier-answers.yml
+          sed -i 's|_src_path: .|_src_path: https://github.com/DiamondLightSource/python-copier-template.git|' example/.copier-answers.yml
 
       - name: Publish example
         # We pin to the SHA, not the tag, for security reasons.

.github/workflows/_release.yml

@@ -23,7 +23,7 @@ jobs:
       - name: Create GitHub Release
         # We pin to the SHA, not the tag, for security reasons.
         # https://docs.github.com/en/actions/learn-github-actions/security-hardening-for-github-actions#using-third-party-actions
-        uses: softprops/action-gh-release@7b4da11513bf3f43f9999e90eabced41ab8bb048 # v2.2.0
+        uses: softprops/action-gh-release@da05d552573ad5aba039eaac05058a918a7bf631 # v2.2.2
         with:
           prerelease: ${{ contains(github.ref_name, 'a') || contains(github.ref_name, 'b') || contains(github.ref_name, 'rc') }}
           files: "*"

.github/workflows/ci.yml

@@ -35,8 +35,8 @@ jobs:
       EXAMPLE_DEPLOY_KEY: ${{ secrets.EXAMPLE_DEPLOY_KEY }}
 
   release:
+    needs: [test, docs]
     if: github.ref_type == 'tag'
-    needs: docs
     uses: ./.github/workflows/_release.yml
     permissions:
       contents: write

README.md

@@ -46,9 +46,9 @@ Visit <https://dev-portal.diamond.ac.uk/create> and you will see a list of templ
 You will need to `pip install copier` inside an activated `venv` from python3.11 or later, then you can create a new module via:
 
 ```
-mkdir /path/to/my-project
-# The --trust argument is required to run setup tasks such as initializing a git repository
-copier copy --trust gh:DiamondLightSource/python-copier-template /path/to/my-project
+git init --initial-branch=main /path/to/my-project
+# $_ resolves to /path/to/my-project
+copier copy https://github.com/DiamondLightSource/python-copier-template.git $_
 ```
 
 You can also use it via `pipx run copier` if you have that installed.

copier.yml

@@ -156,9 +156,6 @@ sphinx:
 
 _subdirectory: "template"
 
-_tasks:
-    - "git init --initial-branch=main"
-
 _migrations:
     - version: 2.0.0
       before:

docs/explanations/decisions/0021-long-form-urls.md

@@ -0,0 +1,19 @@
+# 21. Use long-form URLs in documentation
+
+Date: 2025-05-07
+
+## Status
+
+Accepted
+
+## Context
+
+Copier supports shortcut URLs (see [docs](https://copier.readthedocs.io/en/stable/generating)) of the form `gh:namespace/project`. This was convenient for making our documentation look neater and more digestible to new users, however it is just a convention. When trying to integrate other tools with copier we find that they do not necessarily support the convention. See [this discussion](https://github.com/renovatebot/renovate/discussions/35577) for example.
+
+## Decision
+
+Remove shortcut URLs from this repository and replace them with standard URLs. 
+
+## Consequences
+
+Downstream projects following the documentation will be created with standard URLs and will be supported by renovate and other tools. The alternative solution is to open PRs to these tools so they too support the shortcuts. It was decided that it was quicker, easier and probably more architecturally correct to use long-form URLs since they are already a well-known and widely adopted standard. See [this discussion](https://github.com/epics-containers/services-template-helm/issues/21#issuecomment-2855125741).

docs/how-to/update-template.md

@@ -5,7 +5,7 @@
 To track changes to the upstream template, run
 
 ```
-copier update --trust
+copier update
 ```
 
 This will fetch the latest tagged release of the template, and apply any changes to your working copy. It will prompt for answers again, giving your previous answers as the defaults.
@@ -32,7 +32,7 @@ The following steps are recommended to update your project, especially for infre
 - fix issues found by the above
 - commit the changes
 - update the template
-    - `copier update --trust`
+    - `copier update`
 - fix any merge conflicts
 - validate that the project still works
     - `tox -p`