Skip to content

[CI] Run uv run mkdocs build only on pull requests#2989

Draft
jbampton wants to merge 5 commits into
apache:masterfrom
jbampton:docs-build-clean-up
Draft

[CI] Run uv run mkdocs build only on pull requests#2989
jbampton wants to merge 5 commits into
apache:masterfrom
jbampton:docs-build-clean-up

Conversation

@jbampton
Copy link
Copy Markdown
Member

@jbampton jbampton commented May 22, 2026

Did you read the Contributor Guide?

Is this PR related to a ticket?

  • No:
    • this is a CI update. The PR name follows the format [CI] my subject

What changes were proposed in this PR?

How was this patch tested?

refs #1727

Did this PR include necessary documentation updates?

  • No, this PR does not affect any public API so no need to change the documentation.

@jbampton jbampton added docs github_actions Pull requests that update GitHub Actions code labels May 22, 2026
Comment thread .github/workflows/docs.yml Outdated
@jbampton jbampton marked this pull request as ready for review May 22, 2026 22:04
@jbampton jbampton requested a review from jiayuasu as a code owner May 22, 2026 22:04
@jbampton jbampton requested a review from Copilot May 22, 2026 22:06
Copy link
Copy Markdown
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

This PR updates the documentation GitHub Actions workflow to avoid running an extra mkdocs build during the docs publishing pipeline.

Changes:

  • Removed the unconditional uv run mkdocs build step.
  • Adjusted artifact staging to copy the site/ directory into staging in a single command.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread .github/workflows/docs.yml Outdated
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
@jbampton jbampton changed the title [CI] Remove redundant mkdocs build command from docs build [CI] Run uv run mkdocs build only on pull requests May 22, 2026
@jbampton jbampton requested a review from Copilot May 22, 2026 22:36
Copy link
Copy Markdown
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

Copilot reviewed 1 out of 1 changed files in this pull request and generated 1 comment.

Comment thread .github/workflows/docs.yml
Comment thread .github/workflows/docs.yml Outdated
Copy link
Copy Markdown
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

Copilot reviewed 1 out of 1 changed files in this pull request and generated 1 comment.

@@ -119,8 +121,7 @@ jobs:
version="${GITHUB_REF##*/branch-}"
uv run mike deploy --update-aliases "$version" latest -b website -p
fi
@jbampton jbampton marked this pull request as draft May 22, 2026 22:56
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

docs github_actions Pull requests that update GitHub Actions code

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants