Skip to content

ci: notify qBraid/docs when a release reaches PyPI - #443

Merged
TheGupta2012 merged 3 commits into
mainfrom
ci/notify-docs-on-release
Sep 28, 2026
Merged

TheGupta2012 merged 3 commits into
mainfrom
ci/notify-docs-on-release

Conversation

@ryanhill1

Copy link
Copy Markdown
Member

Adds a notify-docs job that runs after pypi-publish. It tells qBraid/docs which version just reached PyPI, and qBraid/docs then opens a PR bumping its versions.json. Merging that PR moves this release's docs from Latest (tracks main) into Stable (latest PyPI release). See qBraid/docs#336 for the Stable/Latest setup.

  • The job reads the published version from PyPI after a short wait, so it doesn't depend on release tags.
  • continue-on-error: true, and it skips cleanly if the secret is missing, so it can never fail or block a release.
  • qBraid/docs also checks PyPI daily, so a missed event is caught within a day.

Needs an org or repo secret DOCS_DISPATCH_TOKEN: a fine-grained token, or a GitHub App token, with Contents: read and write on qBraid/docs. The GitHub API requires that permission to send a repository_dispatch. Until the secret exists, the job logs a skip.

@argus-eye

argus-eye Bot commented Sep 24, 2026

Copy link
Copy Markdown

Argus review

Auto-review is off for this repo. Tick the box below to run a review on this PR.

  • Trigger Argus review

Estimated cost

  • Files changed: 1
  • Diff lines (±): 20
  • Historical avg: ~317.3k tokens · ~$1.35 · across last 12 review(s)

Tip: you can also comment @argus-eye review at any time.

@coderabbitai

coderabbitai Bot commented Sep 24, 2026 •

Copy link
Copy Markdown

Important

Review skipped

Auto reviews are disabled on this repository. Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

⚙️ Run configuration

Configuration used: Repository: qBraid/pyqasm/.coderabbit.yaml

Review profile: CHILL

Plan: Advanced

Run ID: c1d367ee-206f-416e-849d-10057f1b4eae

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Use the checkbox below for a quick retry:

  • 🔍 Trigger review

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

Comment thread .github/workflows/release.yml Fixed
@codecov-commenter

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.

📢 Thoughts on this report? Let us know!

TheGupta2012 and others added 2 commits September 28, 2026 20:24
CodeQL flagged the new notify-docs job for not limiting the GITHUB_TOKEN
(actions/missing-workflow-permissions, alert 96). The job needs none of it:
the step authenticates with DOCS_DISPATCH_TOKEN and there is no checkout, so
the permissions block is empty rather than a narrowed grant.

Adds the matching Unreleased entry under Other, which the changelog reminder
asked for.

Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
main reset the changelog after the v1.2.1 release, which conflicted with the
new Unreleased entry on this branch. Resolved by keeping main's reset content
and re-adding the notify-docs entry under Other.

Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
@TheGupta2012
TheGupta2012 merged commit 520a020 into main Sep 28, 2026
17 checks passed
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.

4 participants