Merge branch 'review-nov22' of github.com:DiamondLightSource/python3-pip-skeleton into review-nov22

Author: gilesknap

Dockerfile .devcontainer/DockerfileDockerfile renamed to .devcontainer/Dockerfile

@@ -3,8 +3,7 @@
 # The devcontainer should use the build target and run as root with podman
 # or docker with user namespaces.
 #
-FROM python:3.11 as base
-FROM base as build
+FROM python:3.11 as build
 
 ARG PIP_OPTIONS
 
@@ -18,9 +17,9 @@ ARG PIP_OPTIONS
 RUN python -m venv /venv
 ENV PATH=/venv/bin:$PATH
 
-# Copy the project over
-COPY . /project
-WORKDIR /project
+# Copy any required context for the pip install over
+COPY . /context
+WORKDIR /context
 
 # install python package into /venv
 RUN pip install ${PIP_OPTIONS}

.devcontainer.json .devcontainer/devcontainer.json.devcontainer.json renamed to .devcontainer/devcontainer.json

@@ -4,18 +4,17 @@
     "build": {
         "dockerfile": "Dockerfile",
         "target": "build",
-        "context": ".",
+        // Only upgrade pip, we will install the project below
         "args": {
-            "PIP_OPTIONS": "-e .[dev]"
+            "PIP_OPTIONS": "--upgrade pip"
         }
     },
     "remoteEnv": {
         "DISPLAY": "${localEnv:DISPLAY}"
     },
     // Set *default* container specific settings.json values on container create.
     "settings": {
-        "python.defaultInterpreterPath": "/venv/bin/python",
-        "python.linting.enabled": true
+        "python.defaultInterpreterPath": "/venv/bin/python"
     },
     // Add the IDs of extensions you want installed when the container is created.
     "extensions": [
@@ -36,5 +35,7 @@
     ],
     // make the workspace folder the same inside and outside of the container
     "workspaceMount": "source=${localWorkspaceFolder},target=${localWorkspaceFolder},type=bind",
-    "workspaceFolder": "${localWorkspaceFolder}"
+    "workspaceFolder": "${localWorkspaceFolder}",
+    // After the container is created, install the python project in editable form
+    "postCreateCommand": "pip install -e .[dev]"
 }

.dockerignore

@@ -31,7 +31,7 @@ runs:
       run: |
         mkdir -p lockfiles
         pip freeze --exclude-editable > lockfiles/${{ inputs.requirements_file }}
-        # delete the self referencing line
+        # delete the self referencing line and make sure it isn't blank
         sed -i '/file:/d' lockfiles/${{ inputs.requirements_file }}
       shell: bash
 

.github/actions/install_requirements/action.yml

@@ -4,7 +4,7 @@ on:
   push:
   pull_request:
   schedule:
-    # Run every Monday at 8am to check latest versions of dependencies
+    # Run weekly to check latest versions of dependencies
     - cron: "0 8 * * WED"
 env:
   # The target python version, which must match the Dockerfile version
@@ -130,6 +130,8 @@ jobs:
 
       - name: Download wheel and lockfiles
         uses: actions/download-artifact@v3
+        with:
+          path: .devcontainer
 
       - name: Log in to GitHub Docker Registry
         if: github.event_name != 'pull_request'
@@ -160,9 +162,11 @@ jobs:
           push: ${{ github.event_name == 'push' && startsWith(github.ref, 'refs/tags') }}
           load: ${{ ! (github.event_name == 'push' && startsWith(github.ref, 'refs/tags')) }}
           tags: ${{ steps.meta.outputs.tags }}
-          context: .
-          cache-from: type=gha
-          cache-to: type=gha,mode=max
+          context: .devcontainer
+          # If you have a long docker build, uncomment the following to turn on caching
+          # For short build times this makes it a little slower
+          #cache-from: type=gha
+          #cache-to: type=gha,mode=max
 
       - name: Test cli works in runtime image
         run: docker run ${{ env.IMAGE_REPOSITORY }} --version

.github/workflows/code.yml

@@ -3,7 +3,7 @@ name: Link Check
 on:
   workflow_dispatch:
   schedule:
-    # Run every Monday at 8am to check URL links still resolve
+    # Run weekly to check URL links still resolve
     - cron: "0 8 * * WED"
 
 jobs:
@@ -18,18 +18,12 @@ jobs:
     steps:
       - name: Checkout
         uses: actions/checkout@v3
-        with:
-          fetch-depth: 0
 
-      - name: Install python version
-        uses: actions/setup-python@v4
+      - name: Install python packages
+        uses: ./.github/actions/install_requirements
         with:
-          python-version: ${{ matrix.python }}
-
-      - name: Install dependencies
-        run: |
-          touch requirements_dev.txt
-          pip install -r requirements_dev.txt -e .[dev]
+          requirements_file: requirements-dev-3.x.txt
+          install_options: -e .[dev]
 
       - name: Check links
         run: tox -e docs build -- -b linkcheck