Skip to content

Add CI workflow to check mkdocs build on PRs#1086

Open
Copilot wants to merge 2 commits intomainfrom
copilot/add-build-checks-for-mkdocs
Open

Add CI workflow to check mkdocs build on PRs#1086
Copilot wants to merge 2 commits intomainfrom
copilot/add-build-checks-for-mkdocs

Conversation

Copy link
Contributor

Copilot AI commented Mar 12, 2026

The docs site build (uv run mkdocs build) has no CI gate on PRs to main. The existing deploy_site.yml only runs on the publish branch, so Python source changes or dependency updates that break the docs build go undetected until deploy time.

Adds .github/workflows/docs_build_check.yml:

  • Triggers on pushes and PRs to main (same scope as python-app.yml)
  • Runs uv sync --no-dev --frozen — mkdocs and plugins are main deps, not dev; --frozen catches lockfile drift
  • Runs mkdocs build --clean matching the production build command in deploy_site.yml
Original prompt

This section details on the original issue you should resolve

<issue_title>Missing docs build check</issue_title>
<issue_description>We have a python build check for tests, but not for mkdocs and other uv run programs.

Some merge commits can break uv run mkdocs and possibly other programs.

We should have more build tests to cover these.</issue_description>

<agent_instructions>See the existing .github/workflows/ files. Work to create more build tests for the static site.</agent_instructions>

Comments on the Issue (you are @copilot in this section)


✨ Let Copilot coding agent set things up for you — coding agent works faster and does higher quality work when set up for your repo.

Adds a new GitHub Actions workflow that builds the mkdocs documentation
site on every push and pull request to main. This catches documentation
build failures early, preventing broken builds from being merged.

Closes the gap where Python source changes or dependency updates could
break the docs build without being detected by CI.

Co-authored-by: sei-renae <190382933+sei-renae@users.noreply.github.com>
Copilot AI changed the title [WIP] Add missing docs build check for mkdocs Add CI workflow to check mkdocs build on PRs Mar 12, 2026
Copilot AI requested a review from sei-renae March 12, 2026 18:43
Copilot AI requested a review from sei-renae March 18, 2026 19:56
@sei-renae sei-renae marked this pull request as ready for review March 18, 2026 23:27
Copilot AI review requested due to automatic review settings March 18, 2026 23:27
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

Adds a GitHub Actions CI gate to ensure the MkDocs site builds successfully on PRs and pushes to main, catching documentation build breakages earlier than the publish-branch deployment workflow.

Changes:

  • Add a new workflow that runs on push and pull_request events targeting main.
  • Install locked, non-dev dependencies via uv sync --no-dev --frozen.
  • Build the documentation with uv run mkdocs build --clean (matching the deploy workflow).

You can also share your feedback on Copilot code review. Take the survey.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Missing docs build check

3 participants