Make documentation workflow fork-friendly with dynamic branch detection #19
Conversation
This file contains hidden or 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
This commit makes the Sphinx documentation build workflow work seamlessly on forks that may not have all release branches available. Changes: 1. Added python/scripts/get_doc_branches.sh script that dynamically detects available branches (current, master, release-*) in the repository 2. Updated python_sphinx_docs.yml to use the script instead of hardcoded branch lists, removing the need for manual edits when testing on forks 3. Clarified comment to distinguish between manual release branch creation and automatic branch detection Benefits: - Workflow automatically adapts to available branches in any fork - No manual edits needed for testing in development forks - Gracefully handles missing release branches - Automatically includes new release branches as they're added The script checks for remote branches to ensure it works properly with both the main repository (which has all branches) and forks (which may only have a subset).
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
This commit makes the Sphinx documentation build workflow work seamlessly on forks that may not have all release branches available.
Changes:
Added
python/scripts/get_doc_branches.shscript that dynamically detects available branches (current, master, release-*) in the repositoryUpdated
python_sphinx_docs.ymlto use the script instead of hardcoded branch lists, removing the need for manual edits when testing on forksClarified comment to distinguish between manual release branch creation and automatic branch detection
Benefits:
The script checks for remote branches to ensure it works properly with both the main repository (which has all branches) and forks (which may only have a subset).