-
Notifications
You must be signed in to change notification settings - Fork 39
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add script to update version switcher
- Loading branch information
Showing
2 changed files
with
46 additions
and
0 deletions.
There are no files selected for viewing
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
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -76,6 +76,18 @@ jobs: | |
cd docs | ||
make fallback-videos | ||
- name: Update version switcher (on new release) | ||
if: ((github.event_name == 'release' && !contains(github.event.release.tag_name, 'rc')) || (github.event_name == 'workflow_dispatch' && github.event.inputs.target_directory != 'dev')) | ||
run: | | ||
python docs/_scripts/update_switcher.py ${{ github.event.inputs.target_directory || github.event.release.tag_name }} | ||
- name: Commit new version switcher | ||
run: | | ||
git config --local user.email "[email protected]" | ||
git config --local user.name "GitHub Action" | ||
git add docs/_static/version_switcher.json | ||
git commit -m "Update version switcher for release" --allow-empty | ||
- name: Build Docs | ||
uses: aganders3/headless-gui@v2 | ||
env: | ||
|
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,34 @@ | ||
import sys | ||
import json | ||
|
||
|
||
def update_version_switcher(new_version): | ||
"""Update version_switcher.json after a new release.""" | ||
with open("docs/_static/version_switcher.json", "r") as f: | ||
switcher = json.load(f) | ||
oldstable = switcher[1] | ||
|
||
newstable = oldstable.copy() | ||
newstable["version"] = new_version | ||
newstable["name"] = f"stable ({new_version})" | ||
|
||
oldstable["name"] = f"{oldstable['version']}" | ||
del oldstable["preferred"] | ||
oldstable["url"] = oldstable["url"].replace("stable", oldstable["version"]) | ||
|
||
switcher[1] = oldstable | ||
switcher.insert(1, newstable) | ||
with open("docs/_static/version_switcher.json", "w") as f: | ||
json.dump(switcher, f, indent=4) | ||
|
||
print(f"Version switcher updated to {new_version}") | ||
print(f"Old stable version: {switcher[2]}") | ||
print(f"New stable version: {switcher[1]}") | ||
|
||
|
||
if __name__ == "__main__": | ||
if len(sys.argv) != 2: | ||
print("Usage: python update_switcher.py <new_version>") | ||
sys.exit() | ||
new_version = sys.argv[1] | ||
update_version_switcher(new_version) |