Skip to content

ci: standardize docs workflow #1

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
stefan-jansen wants to merge 1 commit into from
Closed

ci: standardize docs workflow #1

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions .github/workflows/docs.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,12 +19,12 @@ jobs:
env:
DOCS_DEPLOY_KEY: ${{ secrets.DOCS_DEPLOY_KEY }}
steps:
- uses: actions/checkout@v4
- uses: actions/checkout@v6
with:
fetch-depth: 0

- name: Install uv
uses: astral-sh/setup-uv@v7
uses: astral-sh/setup-uv@08807647e7069bb48b6ef5acd8ec9567f424441b # v8.1.0
with:
version: "latest"

Expand All @@ -35,7 +35,7 @@ jobs:
run: uv sync --dev --extra docs

- name: Build docs
run: uv run mkdocs build --strict
run: uv run mkdocs build

Copilot AI Apr 29, 2026

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Dropping --strict from the MkDocs build step reduces CI signal (warnings like broken links no longer fail the job). If the intent is to keep docs quality gates, consider restoring --strict or adding an explicit rationale/alternative check so regressions don’t get deployed.

Suggested change
run: uv run mkdocs build
run: uv run mkdocs build --strict

Copilot uses AI. Check for mistakes.

- name: Deploy to website repo
if: ${{ env.DOCS_DEPLOY_KEY != '' }}
Expand Down
Loading