Skip to content

Generate docs for all tag pushes#15894

Merged
jakelishman merged 1 commit intoQiskit:mainfrom
Eric-Arellano:EA/docs-tag
Mar 30, 2026
Merged

Generate docs for all tag pushes#15894
jakelishman merged 1 commit intoQiskit:mainfrom
Eric-Arellano:EA/docs-tag

Conversation

@Eric-Arellano
Copy link
Copy Markdown
Contributor

Summary

The docs team needs to generate the docs for 2.4.0rc2, but there was no Sphinx artifact created. In the past, I would manually trigger a workflow, but that isn't sustainable and the team taking over API release docs generation does not have write permission to Qiskit/qiskit.

Details and comments

This simply runs on all tags. This workflow only uploads the asset to GH Artifacts, whereas it used to update qiskit.org directly. So, running this workflow more than strictly necessary is extremely low risk.

(Technically, we need ** if we want to run on tags that include /.)

@Eric-Arellano Eric-Arellano requested a review from a team as a code owner March 27, 2026 21:40
@qiskit-bot
Copy link
Copy Markdown
Collaborator

One or more of the following people are relevant to this code:

  • @Qiskit/terra-core

@Eric-Arellano
Copy link
Copy Markdown
Contributor Author

It would help to please manually trigger a run of https://github.com/Qiskit/qiskit/actions/workflows/docs_deploy.yml for the recent 2.4.0rc2, then ping @Qiskit/docs-content-team once it is ready for them to generate the docs.

Copy link
Copy Markdown
Member

@jakelishman jakelishman left a comment

Choose a reason for hiding this comment

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

Seems like we've had it like this ever since it was first introduced in #10610, back when this pipeline actually deployed direct to qiskit.org (RIP).

tbh, at this point we can probably just fold the logic into the regular docs job - it's not like either of them push the artifact anywhere.

If you don't care about the version number being set in QISKIT_DOCS_GITHUB_BRANCH_NAME during the env, then you can get the artifact from https://github.com/Qiskit/qiskit/actions/runs/23614935461 (direct link: https://github.com/Qiskit/qiskit/actions/runs/23614935461/artifacts/6131879851). If not, I can manually trigger it tomorrow if you like, or you can just wait til we make a 2.4.0rc3.

@jakelishman jakelishman added this pull request to the merge queue Mar 30, 2026
@jakelishman jakelishman added type: qa Issues and PRs that relate to testing and code quality Changelog: None Do not include in the GitHub Release changelog. labels Mar 30, 2026
Merged via the queue into Qiskit:main with commit 7c68010 Mar 30, 2026
28 checks passed
@Eric-Arellano Eric-Arellano deleted the EA/docs-tag branch March 30, 2026 21:37
@Eric-Arellano
Copy link
Copy Markdown
Contributor Author

Manual trigger would be great. Thanks! We've been trying to stress test the documentation we left behind for generating API docs, which includes how to find the GH artifact.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Changelog: None Do not include in the GitHub Release changelog. type: qa Issues and PRs that relate to testing and code quality

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants