From c7b1d636afb8cfec4e9815ec447fd3bea4688598 Mon Sep 17 00:00:00 2001 From: Kadin Bullock Date: Wed, 13 May 2026 09:55:16 -0600 Subject: [PATCH] ci: fix docs deploy + bump Node 20 actions ahead of June 2 cutoff MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Two CI hygiene fixes: 1. mkdocs docs deploy was failing on every main push because `docs/index.md` links to `changelog.md`, but only `CHANGELOG.md` at the repo root exists. Stage it into `docs/` at build time (mirroring the existing CONTRIBUTING pattern) and add it to mkdocs nav. 2. GitHub is removing Node.js 20 from runners on Sept 16 2026 and forcing the switch on June 2 2026. Bump the deprecated actions: - `actions/checkout@v4` → `@v6` - `astral-sh/setup-uv@v6` → `@v8.1.0` (v8+ removed rolling major tags as a supply-chain mitigation; must pin to exact version) - `actions/setup-python@v5` → `@v6` Verified `mkdocs build --strict` passes locally with the changelog copied into docs/. --- .github/workflows/ci.yml | 16 ++++++++-------- .github/workflows/docs.yml | 5 +++-- mkdocs.yml | 1 + 3 files changed, 12 insertions(+), 10 deletions(-) diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index 84313c8..4db8d45 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -11,8 +11,8 @@ jobs: lint: runs-on: ubuntu-latest steps: - - uses: actions/checkout@v4 - - uses: astral-sh/setup-uv@v6 + - uses: actions/checkout@v6 + - uses: astral-sh/setup-uv@v8.1.0 with: python-version: "3.12" - run: uv sync --extra dev @@ -24,8 +24,8 @@ jobs: matrix: python-version: ["3.11", "3.12", "3.13"] steps: - - uses: actions/checkout@v4 - - uses: astral-sh/setup-uv@v6 + - uses: actions/checkout@v6 + - uses: astral-sh/setup-uv@v8.1.0 with: python-version: ${{ matrix.python-version }} - run: uv sync --extra dev @@ -35,8 +35,8 @@ jobs: needs: [lint, test] runs-on: ubuntu-latest steps: - - uses: actions/checkout@v4 - - uses: astral-sh/setup-uv@v6 + - uses: actions/checkout@v6 + - uses: astral-sh/setup-uv@v8.1.0 with: python-version: "3.12" - run: uv sync --extra dev @@ -51,8 +51,8 @@ jobs: id-token: write environment: pypi steps: - - uses: actions/checkout@v4 - - uses: astral-sh/setup-uv@v6 + - uses: actions/checkout@v6 + - uses: astral-sh/setup-uv@v8.1.0 with: python-version: "3.12" - run: uv build diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml index fb7ba2c..f4d6aed 100644 --- a/.github/workflows/docs.yml +++ b/.github/workflows/docs.yml @@ -18,12 +18,13 @@ jobs: build: runs-on: ubuntu-latest steps: - - uses: actions/checkout@v4 - - uses: actions/setup-python@v5 + - uses: actions/checkout@v6 + - uses: actions/setup-python@v6 with: python-version: "3.12" - run: pip install mkdocs-material - run: cp CONTRIBUTING.md docs/contributing.md + - run: cp CHANGELOG.md docs/changelog.md - run: mkdocs build --strict - uses: actions/upload-pages-artifact@v3 with: diff --git a/mkdocs.yml b/mkdocs.yml index 6ef69a1..cf5f6d8 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -59,6 +59,7 @@ nav: - Getting Started: getting-started.md - CLI Reference: cli-reference.md - Contributing: contributing.md + - Changelog: changelog.md extra: social: