Skip to content

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

Open
ryanhill1 wants to merge 1 commit into
mainfrom
ci/notify-docs-on-release
Open

ryanhill1 wants to merge 1 commit 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: 0d0389de-731b-4d41-b08d-96285ff6223b

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.

@github-actions

Copy link
Copy Markdown
Contributor

👋 Hey there! It looks like the changelog might need an update.

Please take a moment to edit the CHANGELOG.md with:

  • A brief, one-to-two sentence summary of your changes.
  • A link back to this PR for reference.
  • (Optional) A small working example if you've added new features.

Comment on lines +173 to +190
name: Tell qBraid/docs about the release
# Bumps versions.json in qBraid/docs so docs for this release move into the
# Stable docs. Never fails the release.
needs: pypi-publish
runs-on: ubuntu-latest
continue-on-error: true
steps:
- name: Send package-released event
env:
GH_TOKEN: ${{ secrets.DOCS_DISPATCH_TOKEN }}
PKG: pyqasm
run: |
if [ -z "$GH_TOKEN" ]; then echo "DOCS_DISPATCH_TOKEN is not set; skipping"; exit 0; fi
sleep 60 # PyPI's JSON API can trail the upload briefly
VERSION=$(curl -fsSL "https://pypi.org/pypi/${PKG}/json" | jq -r .info.version)
echo "Notifying qBraid/docs: ${PKG} ${VERSION}"
gh api repos/qBraid/docs/dispatches -f event_type=package-released \
-f "client_payload[package]=${PKG}" -f "client_payload[version]=${VERSION}"
@codecov-commenter

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.

📢 Thoughts on this report? Let us know!

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.

3 participants