ci: misc improvements (#1024)

* ci: pre-commit cache + uv cache everywhere * ci(release): dry-run more things * ci(release): use `github.ref_name` for tag
fpgmaas · Jan 12, 2025 · 819b67b · 819b67b
1 parent f3d8c31
commit 819b67b
Show file tree

Hide file tree

Showing 3 changed files with 36 additions and 13 deletions.
diff --git a/.github/workflows/main.yml b/.github/workflows/main.yml
@@ -28,6 +28,8 @@ jobs:
         uses: astral-sh/setup-uv@v5
         with:
           version: ${{ env.UV_VERSION }}
+          enable-cache: true
+          cache-dependency-glob: "uv.lock"
 
       - name: Install Python
         uses: actions/setup-python@v5
@@ -40,8 +42,14 @@ jobs:
       - name: Setup Rust toolchain
         run: rustup component add clippy rustfmt
 
+      - name: Load pre-commit cache
+        uses: actions/cache@v4
+        with:
+          path: ~/.cache/pre-commit
+          key: pre-commit-${{ env.PYTHON_VERSION }}-${{ hashFiles('.pre-commit-config.yaml') }}
+
       - name: Run pre-commit
-        run: uvx pre-commit@${PRE_COMMIT_VERSION} run -a --show-diff-on-failure
+        run: uvx pre-commit@${PRE_COMMIT_VERSION} run --all-files --show-diff-on-failure
         env:
           # renovate: datasource=pypi depName=pre-commit
           PRE_COMMIT_VERSION: '4.0.1'
@@ -73,7 +81,8 @@ jobs:
         uses: astral-sh/setup-uv@v5
         with:
           version: ${{ env.UV_VERSION }}
-          enable-cache: 'true'
+          enable-cache: true
+          cache-dependency-glob: "uv.lock"
           cache-suffix: ${{ matrix.python-version }}
 
       - name: Install Python
@@ -112,6 +121,8 @@ jobs:
         uses: astral-sh/setup-uv@v5
         with:
           version: ${{ env.UV_VERSION }}
+          enable-cache: true
+          cache-dependency-glob: "uv.lock"
 
       - name: Install Python
         uses: actions/setup-python@v5

diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml
@@ -18,17 +18,12 @@ jobs:
         with:
           persist-credentials: false
 
-      - name: Export tag
-        id: vars
-        run: echo tag=${GITHUB_REF#refs/*/} >> $GITHUB_OUTPUT
-        if: ${{ github.event_name == 'release' }}
-
       - name: Update project version
+        if: ${{ github.event_name == 'release' }}
         run: |
           sed -i "s/^version = \".*\"/version = \"$RELEASE_VERSION\"/" pyproject.toml
         env:
-          RELEASE_VERSION: ${{ steps.vars.outputs.tag }}
-        if: ${{ github.event_name == 'release' }}
+          RELEASE_VERSION: ${{ github.ref_name }}
 
       - name: Upload updated pyproject.toml
         uses: actions/upload-artifact@v4
@@ -187,8 +182,11 @@ jobs:
   publish:
     name: Publish
     runs-on: ubuntu-24.04
-    needs: [linux, windows, macos, sdist]
-    if: ${{ github.event_name == 'release' }}
+    needs:
+      - linux
+      - windows
+      - macos
+      - sdist
     steps:
       - uses: actions/download-artifact@v4
 
@@ -198,19 +196,26 @@ jobs:
           python-version: ${{ env.PYTHON_VERSION }}
 
       - name: Publish to PyPI
+        if: ${{ github.event_name == 'release' }}
         uses: PyO3/maturin-action@v1
         env:
           MATURIN_PYPI_TOKEN: ${{ secrets.PYPI_TOKEN }}
         with:
           command: upload
           args: --non-interactive --skip-existing wheels-*/*
 
+      - name: '[dry-run] Publish to PyPI'
+        if: ${{ github.event_name != 'release' }}
+        uses: PyO3/maturin-action@v1
+        with:
+          command: upload
+          args: --help
+
   publish-docs:
     runs-on: ubuntu-24.04
     needs: publish
     permissions:
       contents: write
-    if: ${{ github.event_name == 'release' }}
     steps:
       - name: Check out
         uses: actions/checkout@v4
@@ -219,11 +224,18 @@ jobs:
         uses: astral-sh/setup-uv@v5
         with:
           version: ${{ env.UV_VERSION }}
+          enable-cache: true
+          cache-dependency-glob: "uv.lock"
 
       - name: Install Python
         uses: actions/setup-python@v5
         with:
           python-version: ${{ env.PYTHON_VERSION }}
 
       - name: Deploy documentation
+        if: ${{ github.event_name == 'release' }}
         run: uv run --only-group docs mkdocs gh-deploy --force
+
+      - name: '[dry-run] Deploy documentation'
+        if: ${{ github.event_name != 'release' }}
+        run: uv run --only-group docs mkdocs gh-deploy --help
diff --git a/zizmor.yml b/zizmor.yml
@@ -2,4 +2,4 @@ rules:
   artipacked:
     ignore:
       # Required for publishing documentation to `gh-pages` branch.
-      - release.yml:215
+      - release.yml:220