Skip to content

Commit 4945646

Browse files
github: Add docs-check job to test-and-publish workflow
- Added a new `docs-check` job to `.github/workflows/test-and-publish.yml`: - Configures dependency management with `uv` and caches dev dependencies. - Synchronizes project dependencies using `uv sync`. - Builds documentation using MkDocs with strict mode. - Updated `publish` job to depend on `docs-check`. Assisted-by: Codex
1 parent bbeea0c commit 4945646

1 file changed

Lines changed: 24 additions & 0 deletions

File tree

.github/workflows/test-and-publish.yml

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,29 @@ on:
1212
- published
1313

1414
jobs:
15+
docs-check:
16+
name: Docs Check
17+
runs-on: ubuntu-latest
18+
permissions:
19+
id-token: write
20+
contents: read
21+
packages: write
22+
pull-requests: write
23+
steps:
24+
- uses: actions/checkout@v4
25+
- name: Install uv
26+
uses: astral-sh/setup-uv@v6
27+
with:
28+
version: 0.9.18
29+
python-version: "3.11"
30+
enable-cache: true
31+
cache-suffix: test-and-publish
32+
cache-dependency-glob: uv.lock
33+
- name: Synchronize project dependencies
34+
run: uv sync --group dev
35+
- name: Build docs with MkDocs
36+
run: uv run mkdocs build --strict
37+
1538
tests:
1639
name: Tests (Python ${{ matrix.python-version }})
1740
runs-on: ubuntu-latest
@@ -100,6 +123,7 @@ jobs:
100123
publish:
101124
name: Publish to CodeArtifact
102125
needs:
126+
- docs-check
103127
- tests
104128
- examples
105129
if: github.event_name == 'release'

0 commit comments

Comments
 (0)