Merge pull request #2251 from alan-turing-institute/release-v5.0.1rc1

Release 5.0.1

.all-contributorsrc

@@ -609,6 +609,15 @@
         "bug",
         "doc"
       ]
+    },
+    {
+      "login": "mattwestby",
+      "name": "mattwestby",
+      "avatar_url": "https://avatars.githubusercontent.com/u/91054185?v=4",
+      "profile": "https://github.com/mattwestby",
+      "contributions": [
+        "bug"
+      ]
     }
   ],
   "contributorsSortAlphabetically": true,

.devcontainer/Dockerfile

@@ -6,8 +6,7 @@ RUN apt-get update \
     && export DEBIAN_FRONTEND=noninteractive \
     && apt-get -y install --no-install-recommends \
         git \
-        libssl-dev \
-        python3-sphinx
+        libssl-dev
 
 # Install Azure-CLI
 RUN apt-get update \
@@ -22,7 +21,7 @@ RUN mkdir -p /etc/apt/keyrings \
     && chmod go+r /etc/apt/keyrings/microsoft.gpg
 
 # Set package versions
-ARG AZURE_CLI_VERSION="2.59.0"
+ARG AZURE_CLI_VERSION="2.64.0"
 ARG DISTRIBUTION
 
 # Add the Azure CLI repository
@@ -52,10 +51,6 @@ RUN groupadd --gid $USER_GID $USERNAME \
 # Set the default user
 USER $USERNAME
 
-# Install Sphinx dependencies
-COPY ./docs/requirements.txt /build/requirements.txt
-RUN pip3 install -r /build/requirements.txt
-
 # Set PATH for pulumi - pulumi installed as feature to work round installing as root
 ENV PATH=$PATH:/home/${USERNAME}/.pulumi/bin
 

.devcontainer/devcontainer.json

@@ -10,7 +10,6 @@
     },
     "extensions": [
         "github.vscode-pull-request-github",
-        "ms-vscode.azure-account",
         "ms-python.python",
         "christian-kohler.path-intellisense"
     ],

.github/dependabot.yml

@@ -7,3 +7,15 @@ updates:
     directory: "/"  # The exact logic is unclear, but it recursively searches at least .github/workflows/
     schedule:
       interval: "weekly"
+  # Python package update PRs
+  - package-ecosystem: pip  # This will update 'pyproject.toml'
+    directory: "/"
+    ignore:
+      - dependency-name: "psycopg"  # 3.1.19 is the latest version to support on older MacOS versions
+    groups:
+      production-dependencies:
+        dependency-type: "production"
+      development-dependencies:
+        dependency-type: "development"
+    schedule:
+      interval: weekly

.github/workflows/build_documentation.yaml

@@ -46,7 +46,7 @@ jobs:
         run: hatch run docs:build
 
       - name: Link Checker
-        uses: lycheeverse/lychee-action@v1.10.0
+        uses: lycheeverse/lychee-action@v2.0.2
         with:
           args: --config='./.lychee.toml' --no-progress './docs/build/html/**/*.html'
           fail: true  # fail on broken links

.github/workflows/dependabot_amend.yaml

@@ -0,0 +1,46 @@
+---
+name: Amend Dependabot PRs
+
+on:  # yamllint disable-line rule:truthy
+  push:
+    branches:
+      - dependabot/pip/**
+  pull_request:
+    branches:
+      - dependabot/pip/**
+  workflow_dispatch:  # allow this workflow to be manually triggered
+
+# checkout needs 'contents:read'
+# pull request needs 'pull-requests:write' and 'contents:write'
+permissions:
+  contents: write
+  pull-requests: write
+
+jobs:
+  amend_dependabot_prs:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+
+      - name: Setup Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.12"
+
+      - name: Install hatch
+        run: pip install hatch
+
+      - name: Update hatch requirements
+        run: |
+          rm .hatch/requirements*.txt
+          hatch run true
+          hatch -e docs run true
+          hatch -e lint run true
+          hatch -e test run true
+
+      - name: Commit changes
+        uses: stefanzweifel/[email protected]
+        with:
+          commit_message: "[dependabot skip] :wrench: Update Python requirements files"
+          branch: ${{ github.head_ref }}

.github/workflows/test_code.yaml

@@ -55,7 +55,7 @@ jobs:
         shell: bash
         run: npm install -g markdown-link-check
       - name: Link Checker
-        uses: lycheeverse/lychee-action@v1.10.0
+        uses: lycheeverse/lychee-action@v2.0.2
         with:
           args: --config='./.lychee.toml' --no-progress --offline '**/*.md' --exclude-path './docs'
           fail: true  # fail on broken links

.github/workflows/update_docker_versions.yaml

@@ -40,7 +40,7 @@ jobs:
       - name: Create pull request
         if: ${{ ! env.ACT }}
         id: pull-request
-        uses: peter-evans/create-pull-request@v6.1.0
+        uses: peter-evans/create-pull-request@v7.0.5
         with:
           author: ${{ github.actor }} <${{ github.actor }}@users.noreply.github.com>
           base: develop

.gitignore

@@ -15,6 +15,7 @@ environment_configs/package_lists/dependency-cache.json
 # Python build caches
 __pycache__/
 .venv/
+dist/
 
 # Development tools
 .vscode
@@ -50,3 +51,5 @@ expanded.yaml
 
 # ruff cache
 .ruff_cache
+
+**/venv

docs/requirements.txt → .hatch/requirements-docs.txt

@@ -1,9 +1,13 @@
 #
-# This file is autogenerated by pip-compile with Python 3.12
-# by the following command:
+# This file is autogenerated by hatch-pip-compile with Python 3.12
 #
-#    pip-compile --constraint=requirements-constraints.txt --output-file=docs/requirements.txt -
+# - emoji==2.14.0
+# - myst-parser==4.0.0
+# - pydata-sphinx-theme==0.15.4
+# - sphinx-togglebutton==0.3.2
+# - sphinx==8.1.3
 #
+
 accessible-pygments==0.0.5
     # via pydata-sphinx-theme
 alabaster==1.0.0
@@ -14,22 +18,20 @@ babel==2.16.0
     #   sphinx
 beautifulsoup4==4.12.3
     # via pydata-sphinx-theme
-certifi==2024.7.4
+certifi==2024.8.30
     # via requests
-charset-normalizer==3.3.2
+charset-normalizer==3.4.0
     # via requests
 docutils==0.21.2
     # via
     #   myst-parser
     #   pydata-sphinx-theme
     #   sphinx
     #   sphinx-togglebutton
-emoji==2.12.1
-    # via -r -
-idna==3.7
-    # via
-    #   -c requirements-constraints.txt
-    #   requests
+emoji==2.14.0
+    # via hatch.envs.docs
+idna==3.10
+    # via requests
 imagesize==1.4.1
     # via sphinx
 jinja2==3.1.4
@@ -40,20 +42,20 @@ markdown-it-py==3.0.0
     # via
     #   mdit-py-plugins
     #   myst-parser
-markupsafe==2.1.5
+markupsafe==3.0.2
     # via jinja2
-mdit-py-plugins==0.4.1
+mdit-py-plugins==0.4.2
     # via myst-parser
 mdurl==0.1.2
     # via markdown-it-py
 myst-parser==4.0.0
-    # via -r -
+    # via hatch.envs.docs
 packaging==24.1
     # via
     #   pydata-sphinx-theme
     #   sphinx
 pydata-sphinx-theme==0.15.4
-    # via -r -
+    # via hatch.envs.docs
 pygments==2.18.0
     # via
     #   accessible-pygments
@@ -62,21 +64,19 @@ pygments==2.18.0
 pyyaml==6.0.2
     # via myst-parser
 requests==2.32.3
-    # via
-    #   -c requirements-constraints.txt
-    #   sphinx
+    # via sphinx
 snowballstemmer==2.2.0
     # via sphinx
-soupsieve==2.5
+soupsieve==2.6
     # via beautifulsoup4
-sphinx==8.0.2
+sphinx==8.1.3
     # via
-    #   -r -
+    #   hatch.envs.docs
     #   myst-parser
     #   pydata-sphinx-theme
     #   sphinx-togglebutton
 sphinx-togglebutton==0.3.2
-    # via -r -
+    # via hatch.envs.docs
 sphinxcontrib-applehelp==2.0.0
     # via sphinx
 sphinxcontrib-devhelp==2.0.0
@@ -90,13 +90,9 @@ sphinxcontrib-qthelp==2.0.0
 sphinxcontrib-serializinghtml==2.0.0
     # via sphinx
 typing-extensions==4.12.2
-    # via
-    #   emoji
-    #   pydata-sphinx-theme
-urllib3==2.2.2
-    # via
-    #   -c requirements-constraints.txt
-    #   requests
+    # via pydata-sphinx-theme
+urllib3==2.2.3
+    # via requests
 wheel==0.44.0
     # via sphinx-togglebutton