Merge branch 'main' into debug-services

Ware, Joseph (DLSLtd,RAL,LSCI) · Ware, Joseph (DLSLtd,RAL,LSCI) · commit 7c15c711931c · 2025-05-20T11:15:29.000+01:00
diff --git a/.github/dependabot.yml b/.github/dependabot.yml
@@ -13,6 +13,8 @@ updates:
       actions:
         patterns:
           - "*"
+    commit-message:
+      prefix: "chore"
 
   - package-ecosystem: "pip"
     directory: "/"
@@ -22,3 +24,5 @@ updates:
       dev-dependencies:
         patterns:
           - "*"
+    commit-message:
+      prefix: "chore"
diff --git a/.github/workflows/_check.yml b/.github/workflows/_check.yml
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -2,22 +2,19 @@ name: CI
 
 on:
   push:
+    branches:
+      - main
+    tags:
+      - '*'
   pull_request:
 
 jobs:
-  check:
-    uses: ./.github/workflows/_check.yml
-
   lint:
-    needs: check
-    if: needs.check.outputs.branch-pr == ''
     uses: ./.github/workflows/_tox.yml
     with:
       tox: pre-commit
 
   test:
-    needs: check
-    if: needs.check.outputs.branch-pr == ''
     uses: ./.github/workflows/_test.yml
     with:
       python-version: dev
@@ -26,8 +23,6 @@ jobs:
       CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }}
 
   docs:
-    needs: check
-    if: needs.check.outputs.branch-pr == ''
     uses: ./.github/workflows/_docs.yml
     permissions:
       contents: write
diff --git a/.github/workflows/pr.yml b/.github/workflows/pr.yml
@@ -0,0 +1,15 @@
+name: PR Conventional Commit Validation
+
+on:
+  pull_request:
+    types: [opened, synchronize, reopened, edited]
+
+jobs:
+  validate-pr-title:
+    runs-on: ubuntu-latest
+    steps:
+      - name: PR Conventional Commit Validation
+        uses:  ytanikin/pr-conventional-commits@1.4.1
+        with:
+          task_types: '["feat","fix","docs","test","ci","refactor","perf","chore","revert"]'
+          add_label: 'false'
diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
@@ -1,6 +1,6 @@
 repos:
   - repo: https://github.com/pre-commit/pre-commit-hooks
-    rev: v4.5.0
+    rev: v5.0.0
     hooks:
       - id: check-added-large-files
       - id: check-yaml
diff --git a/.vscode/launch.json b/.vscode/launch.json
@@ -14,10 +14,6 @@
                 "debug-test"
             ],
             "console": "integratedTerminal",
-            "env": {
-                // Enable break on exception when debugging tests (see: tests/conftest.py)
-                "PYTEST_RAISE": "1",
-            },
         }
     ]
 }
diff --git a/README.md b/README.md
@@ -43,7 +43,7 @@ Visit <https://dev-portal.diamond.ac.uk/create> and you will see a list of templ
 
 ## Create a new project from the commandline
 
-You will need to `pip install copier` inside an activated `venv` from python3.10 or later, then you can create a new module via:
+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
diff --git a/docs/explanations/decisions/0021-ci-only-pr.md b/docs/explanations/decisions/0021-ci-only-pr.md
@@ -0,0 +1,24 @@
+# 21. Run CI on pull requests and main branch only
+
+Date: 2025-05-06
+
+## Status
+
+Accepted
+
+## Context
+
+CI has been being run on branches that do not have open pull requests, which has: added spurious jobs to the organisation's compute limit; made workflow definitions more complex; made the results page harder to parse; and allowed known working development branches to become stale or forgotten.
+
+Running CI only on branches that have open pull requests will: reduce compute jobs created for code that is known to not be working; simplify workflow definitions; simplify the CI results page; encourage early creation of pull requests, adding visibility to development.
+
+Draft pull requests will still have CI jobs run, ensuring that code quality is maintained while allowing reviewers to ignore changes that are not ready for human review.
+
+## Decision
+
+CI will only be run on all PRs when changes are made, and on the main branch when PRs are merged into it: not on branches that do not have open PRs.
+Opening a draft PR will allow CI to be run, with the understanding that the PR may not be ready for review.
+
+## Consequences
+
+The `check` job will be removed and CI will run on all PRs and on the `main` branch.
diff --git a/docs/explanations/decisions/0021-conventional-commits.md b/docs/explanations/decisions/0021-conventional-commits.md
@@ -0,0 +1,24 @@
+# 21. Semantic Versioning and Conventional Commits
+
+Date: 2025-04-07
+
+## Status
+
+Proposed
+
+## Context
+
+The template is in a period of both upheaval and uptake, where new users may adopt its use amidst major version changes.
+To give some certainty to users, we should document changes and highlight important ones.
+As dependency management becomes more automated, we should ensure that semantic versioning is used accurately, and make allowances for automation.
+
+## Decision
+
+Commits to the default branch of the copier template should be made using [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/), and the Conventional Commit standard should be used to identify the next released version and create changelogs/release notes.
+
+## Consequences
+
+A [GitHub Action](https://github.com/ytanikin/PRConventionalCommits) has been configured to ensure that PRs may not be merged without being in the form of a Conventional Commit.
+PRs will be squash-and-merged, with the complete git history of the change preserved in the PR but only a single commit on the default branch.
+PR commit messages will be taken from the title and body of the PR, ensuring that the commit will be compatible with the standard.
+Tooling (dependabot etc.) will be configured to make compatible PRs.
diff --git a/docs/explanations/decisions/0022-spec-0.md b/docs/explanations/decisions/0022-spec-0.md
@@ -0,0 +1,19 @@
+# 22. Follow NEP 0029 release cycle
+
+Date: 2025-05-09
+
+## Status
+
+Proposed
+
+## Context
+
+The scientific Python ecosystem, whilst continuing to move to benefit from new Python features, must maintain support for existing projects and provide a reasonable time-frame and predictability for breaking changes. Multiple libraries therefore make use of the [NEP-0029 deprecation policy](https://numpy.org/neps/nep-0029-deprecation_policy.html). We should follow suite.
+
+## Decision
+
+This template will follow the NEP-0029 deprecation policy.
+
+## Consequences
+
+The matrix of supported Python versions will be periodically updated to those expected by the policy. When versions of Python are dropped, this will be considered a Major change for the purposes of Semantic Versioning and ADR #21.
diff --git a/docs/tutorials/installation.md b/docs/tutorials/installation.md
@@ -5,7 +5,7 @@ to create new projects from the template, update existing projects in line with
 
 ## Check your version of python
 
-You will need python 3.10 or later. You can check your version of python by
+You will need python 3.11 or later. You can check your version of python by
 typing into a terminal:
 
 ```
diff --git a/pyproject.toml b/pyproject.toml
@@ -5,7 +5,7 @@ build-backend = "setuptools.build_meta"
 [project]
 name = "python-copier-template"
 dynamic = ["version"]
-requires-python = ">=3.10"
+requires-python = ">=3.11"
 
 [project.optional-dependencies]
 dev = [
diff --git a/template/pyproject.toml.jinja b/template/pyproject.toml.jinja
@@ -7,16 +7,16 @@ name = "{{ distribution_name }}"
 classifiers = [
     "Development Status :: 3 - Alpha",
     "License :: OSI Approved :: Apache Software License",
-    "Programming Language :: Python :: 3.10",
     "Programming Language :: Python :: 3.11",
     "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
 ]
 description = "{{ description }}"
 dependencies = [] # Add project dependencies here, e.g. ["click", "numpy"]
 dynamic = ["version"]
 license.file = "LICENSE"
 readme = "README.md"
-requires-python = ">=3.10"
+requires-python = ">=3.11"
 
 [project.optional-dependencies]
 dev = [
diff --git a/template/{% if git_platform=="github.com" %}.github{% endif %}/workflows/_check.yml b/template/{% if git_platform=="github.com" %}.github{% endif %}/workflows/_check.yml
diff --git a/template/{% if git_platform=="github.com" %}.github{% endif %}/workflows/ci.yml.jinja b/template/{% if git_platform=="github.com" %}.github{% endif %}/workflows/ci.yml.jinja
@@ -5,23 +5,17 @@ on:
   pull_request:
 
 jobs:
-  check:
-    uses: ./.github/workflows/_check.yml
 
   lint:
-    needs: check
-    if: needs.check.outputs.branch-pr == ''
     uses: ./.github/workflows/_tox.yml
     with:
       tox: pre-commit,type-checking
 {% raw %}
   test:
-    needs: check
-    if: needs.check.outputs.branch-pr == ''
     strategy:
       matrix:
         runs-on: ["ubuntu-latest"] # can add windows-latest, macos-latest
-        python-version: ["3.10", "3.11", "3.12"]
+        python-version: ["3.11", "3.12", "3.13"]
         include:
           # Include one that runs in the dev environment
           - runs-on: "ubuntu-latest"
@@ -35,21 +29,15 @@ jobs:
       CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }}
 {% endraw %}{% if docker %}
   container:
-    needs: check
-    if: needs.check.outputs.branch-pr == ''
     uses: ./.github/workflows/_container.yml
     permissions:
       contents: read
       packages: write
 {% endif %}{% if sphinx %}
   docs:
-    needs: check
-    if: needs.check.outputs.branch-pr == ''
     uses: ./.github/workflows/_docs.yml
 {% endif %}
   dist:
-    needs: check
-    if: needs.check.outputs.branch-pr == ''
     uses: ./.github/workflows/_dist.yml
   {% if pypi %}
   pypi:
diff --git a/template/{% if sphinx %}docs{% endif %}/tutorials/installation.md.jinja b/template/{% if sphinx %}docs{% endif %}/tutorials/installation.md.jinja
@@ -2,7 +2,7 @@
 
 ## Check your version of python
 
-You will need python 3.10 or later. You can check your version of python by
+You will need python 3.11 or later. You can check your version of python by
 typing into a terminal:
 
 ```
diff --git a/tests/conftest.py b/tests/conftest.py
@@ -1,21 +0,0 @@
-import os
-from typing import Any
-
-import pytest
-
-# Prevent pytest from catching exceptions when debugging in vscode so that break on
-# exception works correctly (see: https://github.com/pytest-dev/pytest/issues/7409)
-if os.getenv("PYTEST_RAISE", "0") == "1":
-
-    @pytest.hookimpl(tryfirst=True)
-    def pytest_exception_interact(call: pytest.CallInfo[Any]):
-        if call.excinfo is not None:
-            raise call.excinfo.value
-        else:
-            raise RuntimeError(
-                f"{call} has no exception data, an unknown error has occurred"
-            )
-
-    @pytest.hookimpl(tryfirst=True)
-    def pytest_internalerror(excinfo: pytest.ExceptionInfo[Any]):
-        raise excinfo.value

Original file line number	Diff line number	Diff line change
`@@ -14,10 +14,6 @@`
`14`	`14`	`"debug-test"`
`15`	`15`	`],`
`16`	`16`	`"console": "integratedTerminal",`
`17`		`- "env": {`
`18`		`- // Enable break on exception when debugging tests (see: tests/conftest.py)`
`19`		`- "PYTEST_RAISE": "1",`
`20`		`- },`
`21`	`17`	`}`
`22`	`18`	`]`
`23`	`19`	`}`