-
Notifications
You must be signed in to change notification settings - Fork 2.6k
Add GitHub Actions documentation-deployment pipeline (backport #10610) #10638
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
* Add GitHub Actions documentation-deployment pipeline This brings a documentation-deployment pipeline into the Qiskit/Terra repository, allowing it to fully deploy its documentation to `qiskit.org`, a task previously only the metapackage could perform. This does not fully unify the documentation with files from the metapackage, it just adds a pipeline to do the final deployment. This includes a revitalised translatable-strings pipeline, which was previously broken on the metapackage for the last month or two. It also previously included a fair amount of legacy weight that was no longer relevant. * Add missing secret insertions * Improve logic for deployments This changes the logic for the deployments so that pushes to 'stable/*' no longer trigger any deployment to qiskit.org. Instead, tag events trigger a deployment to the relevant stable branch, and a tag event of the _latest_ tag triggers a deployment to the documentation root. The translatables logic is modified to push only the latest full-release tag. (cherry picked from commit 80e95d1) # Conflicts: # docs/conf.py
Thank you for opening a new pull request. Before your PR can be merged it will first need to pass continuous integration tests and be reviewed. Sometimes the review process can be slow, so please be patient. While you're waiting, please feel free to review other open PRs. While only a subset of people are authorized to approve pull requests for merging, everyone is encouraged to review open pull requests. Doing reviews helps reduce the burden on the core team and helps make the project's code better for everyone. One or more of the the following people are requested to review this:
|
Pull Request Test Coverage Report for Build 5879327489
💛 - Coveralls |
An interesting note on this backport is we will be tagging 0.25.1 which will trigger the build to be uploaded to the wrong path: |
I tried to address the conflicts. But probably somebody else should have a look. |
docs/conf.py
Outdated
html_theme_options = { | ||
"logo_only": True, | ||
"display_version": True, | ||
"prev_next_buttons_location": "bottom", | ||
"style_external_links": True, | ||
} |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@1ucian0 bad change
For any tag we publish from the `stable/0.25` branch the publish path should be both `stable/0.44` (which matches the qiskit package version) and the root as it's the current release. When we stop publishing from the stable/0.25 branch after the release of 0.45.0rc1 the existing logic will work and we'll no longer have any 0.25.x releases. But for the 0.25.x release series only the version numbers are not unified so we need to manually ensure we're publishing to the right paths.
@@ -26,7 +26,16 @@ | |||
# The short X.Y version | |||
version = "0.25" | |||
# The full version, including alpha/beta/rc tags | |||
release = "0.25.0" | |||
release = "0.45.0" |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@mtreinish bad merge conflict, right?
release = "0.45.0" | |
release = "0.25.0" |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
It's actually 0.44.0 now and will be 0.44.1 on the 0.25.1 release, but I had fixed this in #10644 so I didn't view it as critical for this PR.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Sgtm to hardcode things for 0.44.
This is an automatic backport of pull request #10610 done by Mergify.
Cherry-pick of 80e95d1 has failed:
To fix up this pull request, you can check it out locally. See documentation: https://docs.github.com/en/github/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/checking-out-pull-requests-locally
Mergify commands and options
More conditions and actions can be found in the documentation.
You can also trigger Mergify actions by commenting on this pull request:
@Mergifyio refresh
will re-evaluate the rules@Mergifyio rebase
will rebase this PR on its base branch@Mergifyio update
will merge the base branch into this PR@Mergifyio backport <destination>
will backport this PR on<destination>
branchAdditionally, on Mergify dashboard you can:
Finally, you can contact us on https://mergify.com