Skip to content

Deploy docs on version tags and by hand only - #48

Merged
pattonw merged 2 commits into
mainfrom
docs-deploy-on-tags
Nov 11, 2026
Merged

pattonw merged 2 commits into
mainfrom
docs-deploy-on-tags

Conversation

@pattonw

@pattonw pattonw commented Nov 11, 2026 •

Copy link
Copy Markdown
Contributor

What changes

  • Triggers: the docs workflow runs on a v* tag push and on workflow_dispatch only. It no longer runs after every benchmark run on main, and it does not run on pull request commits.
  • Deploy guard: the Pages artifact upload and the deploy job run only for a tag or for main. A manual run on any other branch builds without deploying.
  • Concurrency: one run at a time per ref, and a running deploy is never cancelled.

How to use it

  • Check a pull request's docs: when the pull request is ready to merge, start the docs workflow by hand on its branch (Actions → docs → Run workflow, or gh workflow run docs --ref <branch>). The result shows on the pull request's head commit.
  • Release: push the version bump to main as the last commit, wait for tests and benchmark to finish on it, then tag. The tag's deploy then includes a benchmark point measured on the released commit.
  • Redeploy: start the workflow by hand on main.

Benchmark data is still recorded on every push to main; the published charts refresh at each deploy.

Test matrix

A further commit makes the lowest-direct test leg test what its name says. The resolution mode was passed to uv sync only; the following uv run pytest re-resolved to the newest versions, so the declared dependency floors were never tested. The mode is now set once for the whole job as UV_RESOLUTION. If this leg fails on this pull request, a declared floor is too low.

Repository setting

The github-pages environment has a v* tag rule next to its branch rules, so a tag push is allowed to deploy.

Testing

The workflow file parses. It has not been run on this branch; the same form deployed the volara 2.1.0 docs from a tag.

🤖 Generated with Claude Code

pattonw and others added 2 commits November 11, 2026 09:04
The docs workflow now runs on a v* tag push and on workflow_dispatch, and
not on every push or pull request commit. A tag or a manual run on main
deploys; a manual run on any other branch builds without deploying, which
is how a pull request's docs are checked once it is ready to merge.

Co-Authored-By: Claude Fable 5.2 <noreply@anthropic.com>
The resolution mode was passed to `uv sync` only. The next step, a plain
`uv run pytest`, saw a lockfile written in another mode, re-resolved to the
newest versions and replaced the environment, so the leg named
lowest-direct tested unlocked newest versions instead. The mode is now set
once as UV_RESOLUTION for the whole job.

Co-Authored-By: Claude Fable 5.2 <noreply@anthropic.com>
@pattonw
pattonw merged commit 12f4931 into main Nov 11, 2026
5 checks passed
@pattonw
pattonw deleted the docs-deploy-on-tags branch November 11, 2026 19:02
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.

1 participant