ci(python): On Python release, trigger docs build after API reference build #17904
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
github-actions
bot
added
internal
stinodego
force-pushed
the
fix-docs-deploy
branch
from
f1aa5bd
to
fe0c685
Compare
stinodego
commented
Jul 27, 2024
| @@ -51,7 +51,7 @@ jobs: | |||
| run: make html | |||
|
|
|||
| - name: Deploy Python docs for latest development version | |||
| if: ${{ github.ref_name == 'main' }} | |||
| if: github.event_name == 'push' && github.ref_name == 'main' | |||
There was a problem hiding this comment.
Drive-by: we don't need to build the dev docs on Python release, as they are already updated with every push to main.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Closes #17329
I believe the issue is that the global docs workflow and the Python docs workflow try updating the
gh-pagesbranch simultaneously. This leads to some of the updates being lost, e.g.:Now the global docs will be built after the Python API docs. That should take care of the issue.
Not super happy with this fix - it introduces some complexity - but it should work.