Skip to content

ci: dispatch documentation after successful releases - #135

Open
tjduigna wants to merge 1 commit into
mainfrom
fix/dispatch-release-docs
Open

tjduigna wants to merge 1 commit into
mainfrom
fix/dispatch-release-docs

Conversation

@tjduigna

Copy link
Copy Markdown
Contributor

Release tags pushed by the Package workflow use GITHUB_TOKEN, so GitHub suppresses the tag-push event that would otherwise start documentation deployment. This left the v1.0.0 release without a docs run.

After publishing to PyPI and successfully pushing a new release tag, explicitly dispatch docs.yaml against that exact tag. Grant actions: write for the dispatch and retain the existing version-bump condition and default success gating. Also quote $GITHUB_OUTPUT to resolve an existing ShellCheck finding in the modified workflow.

Validation:

  • actionlint .github/workflows/main.yaml .github/workflows/docs.yaml passed.
  • pre-commit run --files .github/workflows/main.yaml passed.
  • git diff --check passed.

No live release or docs deployment was triggered during validation. This change applies to future releases; it does not backfill v1.0.0.

@github-actions

Copy link
Copy Markdown

Coverage report

This PR does not seem to contain any modification to coverable code.

@tjduigna
tjduigna requested a review from Ninjani October 14, 2026 19:38

@Ninjani Ninjani left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

LGTM

This branch has not been deployed

No deployments
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.

2 participants