Adopt python-copier-template 1.0.0

.copier-answers.yml

@@ -0,0 +1,14 @@
+# Changes here will be overwritten by Copier
+_commit: 1.0.0
+_src_path: gh:DiamondLightSource/python-copier-template
+author_email: [email protected]
+author_name: Tom Cobb
+component_owner: group:default/sscc
+description: Create an IOC from a PandA
+distribution_name: pandablocks-ioc
+docker: true
+docs_type: sphinx
+git_platform: github.com
+github_org: PandABlocks
+package_name: pandablocks_ioc
+repo_name: PandABlocks-ioc

.devcontainer/devcontainer.json

@@ -3,50 +3,53 @@
     "name": "epics-containers IOC devcontainer",
     "build": {
         "dockerfile": "../Dockerfile",
-        "context": "..",
-        "target": "developer",
+        "target": "build",
+        // Only upgrade pip, we will install the project below
         "args": {
-            "TARGET_ARCHITECTURE": "linux",
             "PIP_OPTIONS": "--upgrade pip"
         }
     },
     "remoteEnv": {
-        "DISPLAY": "${localEnv:DISPLAY}",
-        "PIP_OPTIONS": "--upgrade pip"
+        "DISPLAY": "${localEnv:DISPLAY}"
+    },
+    // Add the URLs of features you want added when the container is built.
+    "features": {
+        "ghcr.io/devcontainers/features/common-utils:1": {
+            "username": "none",
+            "upgradePackages": false
+        }
+    },
+    // Set *default* container specific settings.json values on container create.
+    "settings": {
+        "python.defaultInterpreterPath": "/venv/bin/python"
     },
     "customizations": {
         "vscode": {
             // Add the IDs of extensions you want installed when the container is created.
             "extensions": [
-                "ms-python.vscode-pylance",
+                "ms-python.python",
                 "tamasfe.even-better-toml",
                 "redhat.vscode-yaml",
                 "ryanluker.vscode-coverage-gutters",
-                "epicsdeb.vscode-epics",
-                "ms-python.black-formatter"
+                "epicsdeb.vscode-epics"
             ]
-        },
-        "settings": {
-            // global python venv created in epics-base
-            "python.defaultInterpreterPath": "/venv/bin/python"
         }
     },
     // Make sure the files we are mapping into the container exist on the host
-    "initializeCommand": "bash .devcontainer/initializeCommand ${devcontainerId}",
-    "postCreateCommand": "bash .devcontainer/postCreateCommand ${devcontainerId}",
+    "initializeCommand": "bash -c 'for i in $HOME/.inputrc; do [ -f $i ] || touch $i; done'",
     "runArgs": [
         "--net=host",
-        "--security-opt=label=disable"
+        "--security-opt=label=type:container_runtime_t"
     ],
-    "workspaceMount": "source=${localWorkspaceFolder},target=/epics/${localWorkspaceFolderBasename},type=bind",
-    "workspaceFolder": "/epics/${localWorkspaceFolderBasename}",
     "mounts": [
-        // Mount some useful local files from the user's home directory
-        "source=${localEnv:HOME}/.bash_eternal_history,target=/root/.bash_eternal_history,type=bind",
-        "source=${localWorkspaceFolder}/.devcontainer/.bashrc,target=/root/.bashrc,type=bind",
-        "source=${localEnv:HOME}/.bashrc_dev_container,target=/root/.bashrc_dev_container,type=bind",
-        "source=${localEnv:HOME}/.gitconfig,target=/root/.gitconfig,type=bind",
+        "source=${localEnv:HOME}/.ssh,target=/root/.ssh,type=bind",
         "source=${localEnv:HOME}/.inputrc,target=/root/.inputrc,type=bind",
-        "source=${localEnv:HOME}/.ssh,target=/root/.ssh,type=bind"
-    ]
-}
+        // map in home directory - not strictly necessary but useful
+        "source=${localEnv:HOME},target=${localEnv:HOME},type=bind,consistency=cached"
+    ],
+    // make the workspace folder the same inside and outside of the container
+    "workspaceMount": "source=${localWorkspaceFolder},target=${localWorkspaceFolder},type=bind",
+    "workspaceFolder": "${localWorkspaceFolder}",
+    // After the container is created, install the python project in editable form
+    "postCreateCommand": "pip install -e '.[dev]'"
+}

.github/actions/install_requirements/action.yml

@@ -7,6 +7,9 @@ inputs:
   install_options:
     description: Parameters to pass to pip install
     required: true
+  artifact_name:
+    description: A user friendly name to give the produced artifacts
+    required: true
   python_version:
     description: Python version to install
     default: "3.x"
@@ -16,7 +19,7 @@ runs:
 
   steps:
     - name: Setup python
-      uses: actions/setup-python@v4
+      uses: actions/setup-python@v5
       with:
         python-version: ${{ inputs.python_version }}
 
@@ -32,13 +35,13 @@ runs:
         mkdir -p lockfiles
         pip freeze --exclude-editable > lockfiles/${{ inputs.requirements_file }}
         # delete the self referencing line and make sure it isn't blank
-        sed -i '/file:/d' lockfiles/${{ inputs.requirements_file }}
+        sed -i'' -e '/file:/d' lockfiles/${{ inputs.requirements_file }}
       shell: bash
 
     - name: Upload lockfiles
-      uses: actions/upload-artifact@v3
+      uses: actions/upload-artifact@v4.0.0
       with:
-        name: lockfiles
+        name: lockfiles-${{ inputs.python_version }}-${{ inputs.artifact_name }}-${{ github.sha }}
         path: lockfiles
 
     # This eliminates the class of problems where the requirements being given no
@@ -55,4 +58,3 @@ runs:
           fi
         fi
       shell: bash
-

.github/dependabot.yml

@@ -9,6 +9,10 @@ updates:
     directory: "/"
     schedule:
       interval: "weekly"
+    groups:
+      github-artifacts:
+        patterns:
+          - actions/*-artifact
 
   - package-ecosystem: "pip"
     directory: "/"

.github/pages/index.html

@@ -8,4 +8,4 @@
     <link rel="canonical" href="main/index.html">
 </head>
 
-</html>
+</html>

.github/pages/make_switcher.py

@@ -59,12 +59,12 @@ def get_versions(ref: str, add: Optional[str], remove: Optional[str]) -> List[st
 def write_json(path: Path, repository: str, versions: str):
     org, repo_name = repository.split("/")
     struct = [
-        dict(version=version, url=f"https://{org}.github.io/{repo_name}/{version}/")
+        {"version": version, "url": f"https://{org}.github.io/{repo_name}/{version}/"}
         for version in versions
     ]
     text = json.dumps(struct, indent=2)
     print(f"JSON switcher:\n{text}")
-    path.write_text(text)
+    path.write_text(text, encoding="utf-8")
 
 
 def main(args=None):