Merge pull request #33 from znicholls/update-copier

znicholls · web-flow · commit 129009ea7c7a · 2025-09-12T08:07:21.000+02:00
Update copier and add other authors
diff --git a/.copier-answers.yml b/.copier-answers.yml
@@ -1,5 +1,5 @@
 # Changes here will be overwritten by Copier; NEVER EDIT MANUALLY
-_commit: v0.12.3
+_commit: v0.14.3
 _src_path: gl:openscm/copier-core-python-repository
 conda_release: false
 email: zebedee.nicholls@climate-energy-college.org
diff --git a/.github/actions/setup/action.yml b/.github/actions/setup/action.yml
@@ -20,7 +20,7 @@ runs:
       id: setup-uv
       uses: astral-sh/setup-uv@v4
       with:
-        version: "0.5.21"
+        version: "0.8.8"
         python-version: ${{ inputs.python-version }}
     - name: Install dependencies
       shell: bash
diff --git a/.github/workflows/bump.yaml b/.github/workflows/bump.yaml
@@ -1,25 +1,21 @@
 name: Bump version
-# For the time being, we still do this with pdm.
-# Honestly, it doesn't really matter,
-# but one day uv will have a bump command too and we can switch to that.
-# Relevant issue in uv: https://github.com/astral-sh/uv/issues/6298
 
 on:
   workflow_dispatch:
     inputs:
       bump_rule:
         type: choice
-        description: How to bump the project's version (see https://github.com/carstencodes/pdm-bump#usage)
+        description: How to bump the project's version (see https://docs.astral.sh/uv/reference/cli/#uv-version)
         options:
-          - no-pre-release
-          # no micro because we always sit on a pre-release in main,
-          # so we would always use no-pre-release instead of micro
-          # - micro
+          - patch
           - minor
           - major
-          - "pre-release --pre alpha"
-          - "pre-release --pre beta"
-          - "pre-release --pre release-candidate"
+          - stable
+          - alpha
+          - beta
+          - rc
+          - post
+          - dev
         required: true
 
 jobs:
@@ -29,7 +25,7 @@ jobs:
     strategy:
       matrix:
         os: [ "ubuntu-latest" ]
-        python-version: [ "3.9" ]
+        python-version: [ "3.11" ]
     runs-on: "${{ matrix.os }}"
     env:
       CI_COMMIT_EMAIL: "ci-runner@cmip-branded-variable-mapper.invalid"
@@ -40,15 +36,6 @@ jobs:
           fetch-depth: 0
           token: "${{ secrets.PERSONAL_ACCESS_TOKEN }}"
 
-      - name: Setup PDM
-        uses: pdm-project/setup-pdm@v4.1
-        with:
-          python-version: ${{ matrix.python-version }}
-
-      - name: Install pdm-bump
-        run: |
-          pdm self add pdm-bump
-
       - uses: ./.github/actions/setup
         with:
           python-version: ${{ matrix.python-version }}
@@ -59,13 +46,13 @@ jobs:
           git config --global user.name "$GITHUB_ACTOR"
           git config --global user.email "$CI_COMMIT_EMAIL"
 
-          BASE_VERSION=`sed -ne 's/^version = "\([0-9\.a]*\)"/\1/p' pyproject.toml`
+          BASE_VERSION=`sed -ne 's/^version = "\([0-9\.post]*\)"/\1/p' pyproject.toml`
           echo "Bumping from version $BASE_VERSION"
 
           # Bump
-          pdm bump ${{ github.event.inputs.bump_rule }}
+          uv version --bump ${{ github.event.inputs.bump_rule }}
 
-          NEW_VERSION=`sed -ne 's/^version = "\([0-9\.a]*\)"/\1/p' pyproject.toml`
+          NEW_VERSION=`sed -ne 's/^version = "\([0-9\.]*\)"/\1/p' pyproject.toml`
           echo "Bumping to version $NEW_VERSION"
 
           # Build CHANGELOG
@@ -78,12 +65,12 @@ jobs:
 
           # Bump to alpha (so that future commits do not have the same
           # version as the tagged commit)
-          BASE_VERSION=`sed -ne 's/^version = "\([0-9\.a]*\)"/\1/p' pyproject.toml`
+          BASE_VERSION=`sed -ne 's/^version = "\([0-9\.]*\)"/\1/p' pyproject.toml`
 
           # Bump to pre-release of next version
-          pdm bump pre-release --pre alpha
+          uv version --bump post
 
-          NEW_VERSION=`sed -ne 's/^version = "\([0-9\.a]*\)"/\1/p' pyproject.toml`
+          NEW_VERSION=`sed -ne 's/^version = "\([0-9\.post]*\)"/\1/p' pyproject.toml`
           echo "Bumping version $BASE_VERSION > $NEW_VERSION"
 
           # Commit and push
diff --git a/.github/workflows/ci.yaml b/.github/workflows/ci.yaml
@@ -137,7 +137,7 @@ jobs:
         id: setup-uv
         uses: astral-sh/setup-uv@v4
         with:
-          version: "0.5.21"
+          version: "0.8.8"
           python-version: ${{ matrix.python-version }}
       - name: Create venv
         run: |
@@ -181,7 +181,8 @@ jobs:
       - name: Install
         run: |
           pip install --upgrade pip wheel
-          pip install .
+          pip install --no-deps .
+          pip install -r requirements-locked.txt
           pip install -r requirements-only-tests-min-locked.txt
       - name: Run tests
         run: |
@@ -223,21 +224,15 @@ jobs:
         id: setup-uv
         uses: astral-sh/setup-uv@v4
         with:
-          version: "0.5.21"
-          python-version: ${{ matrix.python-version }}
-      - name: Setup PDM
-        uses: pdm-project/setup-pdm@v4.1
-        with:
+          version: "0.8.8"
           python-version: ${{ matrix.python-version }}
-      - name: Generate pdm.lock
-        # Required for building the locked version of the package
-        # with pdm-build-locked (see pyproject.toml)
-        run: |
-          pdm lock --group :all --strategy inherit_metadata --python="<3.13"
-          pdm lock --group :all  --python=">=3.13" --append
       - name: Build package
         run: |
+          uv run python scripts/add-locked-targets-to-pyproject-toml.py
+          cat pyproject.toml
           uv build
+          # Just in case, undo the changes to `pyproject.toml`
+          git restore --staged . && git restore .
       - name: Check build
         run: |
           tar -tvf dist/cmip_branded_variable_mapper-*.tar.gz --wildcards '*cmip_branded_variable_mapper/py.typed'
diff --git a/.github/workflows/deploy.yaml b/.github/workflows/deploy.yaml
@@ -32,19 +32,12 @@ jobs:
         id: setup-uv
         uses: astral-sh/setup-uv@v4
         with:
-          version: "0.5.21"
+          version: "0.8.8"
           python-version: ${{ matrix.python-version }}
-      - name: Setup PDM
-        uses: pdm-project/setup-pdm@v4.1
-        with:
-          python-version: ${{ matrix.python-version }}
-      - name: Generate pdm.lock
-        # Required for building the locked version of the package
-        # with pdm-build-locked (see pyproject.toml)
-        run: |
-          pdm lock --group :all --strategy inherit_metadata --python="<3.13"
-          pdm lock --group :all  --python=">=3.13" --append
       - name: Publish to PyPI
         run: |
+          uv run python scripts/add-locked-targets-to-pyproject-toml.py
           uv build
           uv publish
+          # Just in case, undo the changes to `pyproject.toml`
+          git restore --staged . && git restore .
diff --git a/.github/workflows/release.yaml b/.github/workflows/release.yaml
@@ -14,7 +14,7 @@ jobs:
     strategy:
       matrix:
         os: [ "ubuntu-latest" ]
-        python-version: [ "3.9" ]
+        python-version: [ "3.11" ]
     runs-on: "${{ matrix.os }}"
     steps:
       - name: Check out repository
@@ -25,25 +25,18 @@ jobs:
         id: setup-uv
         uses: astral-sh/setup-uv@v4
         with:
-          version: "0.5.21"
+          version: "0.8.8"
           python-version: ${{ matrix.python-version }}
-      - name: Setup PDM
-        uses: pdm-project/setup-pdm@v4.1
-        with:
-          python-version: ${{ matrix.python-version }}
-      - name: Generate pdm.lock
-        # Required for building the locked version of the package
-        # with pdm-build-locked (see pyproject.toml)
-        run: |
-          pdm lock --group :all --strategy inherit_metadata --python="<3.13"
-          pdm lock --group :all  --python=">=3.13" --append
       - name: Add version to environment
         run: |
-          PROJECT_VERSION=`sed -ne 's/^version = "\([0-9\.a]*\)"/\1/p' pyproject.toml`
+          PROJECT_VERSION=`sed -ne 's/^version = "\([0-9\.]*\)"/\1/p' pyproject.toml`
           echo "PROJECT_VERSION=$PROJECT_VERSION" >> $GITHUB_ENV
       - name: Build package for PyPI
         run: |
+          uv run python scripts/add-locked-targets-to-pyproject-toml.py
           uv build
+          # Just in case, undo the changes to `pyproject.toml`
+          git restore --staged . && git restore .
       - name: Generate Release Notes
         run: |
           echo "" >> ".github/release_template.md"
diff --git a/.github/workflows/test-upstream-latest.yaml b/.github/workflows/test-upstream-latest.yaml
@@ -36,7 +36,7 @@ jobs:
         id: setup-uv
         uses: astral-sh/setup-uv@v4
         with:
-          version: "0.5.21"
+          version: "0.8.8"
           python-version: ${{ matrix.python-version }}
       # Often you need a step like this for e.g. numpy, scipy, pandas
       - name: Setup compilation dependencies
diff --git a/Makefile b/Makefile
@@ -77,7 +77,6 @@ licence-check:  ## Check that licences of the dependencies are suitable
 	uv run liccheck -r $(TEMP_FILE) -R licence-check.txt
 	rm -f $(TEMP_FILE)
 
-
 .PHONY: virtual-environment
 virtual-environment:  ## update virtual environment, create a new one if it doesn't already exist
 	uv sync --all-extras --group all-dev
diff --git a/changelog/33.trivial.md b/changelog/33.trivial.md
@@ -0,0 +1 @@
+Added other authors and updated copier version (no more pdm :D)
diff --git a/docs/development.md b/docs/development.md
@@ -48,16 +48,16 @@ should change depending on the updates to the code base.
 Releasing is semi-automated via a CI job.
 The CI job requires the type of version bump
 that will be performed to be manually specified.
-See the pdm-bump docs for the
-[list of available bump rules](https://github.com/carstencodes/pdm-bump#usage).
+See the `uv version` docs (specifically the `--bump` flag) for the
+[list of available bump rules](https://docs.astral.sh/uv/reference/cli/#uv-version).
 
 ### Standard process
 
 The steps required are the following:
 
 1. Bump the version: manually trigger the "bump" workflow from the main branch
    (see here: [bump workflow](https://github.com/znicholls/CMIP-branded-variables-mapper/actions/workflows/bump.yaml)).
-   A valid "bump_rule" (see [pdm-bump's docs](https://github.com/carstencodes/pdm-bump#usage))
+   A valid "bump_rule" (see [uv's docs](https://docs.astral.sh/uv/reference/cli/#uv-version))
    will need to be specified.
    This will then trigger a draft release.
 
@@ -78,12 +78,10 @@ The steps required are the following:
 
 #### Further details
 
-We use [pdm](https://pdm-project.org/en/latest/) for building our project,
-while [uv figures out how it wants to support building](https://github.com/astral-sh/uv/issues/3957).
-This gives us the added benefit that we can use
-[pdm-build-locked](https://pdm-build-locked.readthedocs.io/en/stable/)
-to build locked versions of our package.
-It is for these reasons that we create a `pdm.lock` file
+We use [uv's build backend](https://docs.astral.sh/uv/concepts/build-backend) for building our project
+and `scripts/add-locked-targets-to-pyproject-toml.py`
+to provide locked extra groups for our package.
+Including locked extra groups is why we run `scripts/add-locked-targets-to-pyproject-toml.py`
 before any step related to building the package in the CI.
 
 ## Read the Docs
diff --git a/mkdocs.yml b/mkdocs.yml
@@ -68,7 +68,7 @@ plugins:
       handlers:
         python_xref:
           paths: [src]
-          import:
+          inventories:
             # Cross-ref helpers (lots included here, remove what you don't want)
             - https://www.attrs.org/en/stable/objects.inv
             - https://unidata.github.io/cftime/objects.inv
@@ -91,8 +91,19 @@ plugins:
             - https://validators.readthedocs.io/en/stable/objects.inv
             - http://xarray.pydata.org/en/stable/objects.inv
           options:
+            # It turns out that xref does this check without considering config.
+            # As a result, every docstring is parsed as a google-style docstring.
+            # As docstrings are only parsed once, this results in rendering failures.
+            # Hence, turn off the checks here.
+            # mkdocs_autorefs catches anything which doesn't end up being a correct reference.
+            # The fix might be as simple as changing
+            # `self.collect(ref, PythonOptions())`
+            # to `self.collect(ref, self.get_options({}))`
+            # in the python-xref source, but it's hard to predict the side effects
+            # so we haven't bothered with that route.
+            check_crossrefs: false
             docstring_style: numpy
-            relative_crossrefs: yes
+            relative_crossrefs: true
             separate_signature: true
             show_root_heading: false
             show_signature_annotations: true
diff --git a/pyproject.toml b/pyproject.toml
diff --git a/requirements-docs-locked.txt b/requirements-docs-locked.txt
diff --git a/requirements-locked.txt b/requirements-locked.txt
diff --git a/scripts/add-locked-targets-to-pyproject-toml.py b/scripts/add-locked-targets-to-pyproject-toml.py
diff --git a/uv.lock b/uv.lock

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1 @@`
	`1`	`+Added other authors and updated copier version (no more pdm :D)`