|
| 1 | +import json |
| 2 | +import logging |
| 3 | +from argparse import ArgumentParser |
| 4 | +from pathlib import Path |
| 5 | +from subprocess import CalledProcessError, check_output |
| 6 | +from typing import List, Optional |
| 7 | + |
| 8 | + |
| 9 | +def report_output(stdout: bytes, label: str) -> List[str]: |
| 10 | + ret = stdout.decode().strip().split("\n") |
| 11 | + print(f"{label}: {ret}") |
| 12 | + return ret |
| 13 | + |
| 14 | + |
| 15 | +def get_branch_contents(ref: str) -> List[str]: |
| 16 | + """Get the list of directories in a branch.""" |
| 17 | + stdout = check_output(["git", "ls-tree", "-d", "--name-only", ref]) |
| 18 | + return report_output(stdout, "Branch contents") |
| 19 | + |
| 20 | + |
| 21 | +def get_sorted_tags_list() -> List[str]: |
| 22 | + """Get a list of sorted tags in descending order from the repository.""" |
| 23 | + stdout = check_output(["git", "tag", "-l", "--sort=-v:refname"]) |
| 24 | + return report_output(stdout, "Tags list") |
| 25 | + |
| 26 | + |
| 27 | +def get_versions(ref: str, add: Optional[str], remove: Optional[str]) -> List[str]: |
| 28 | + """Generate the file containing the list of all GitHub Pages builds.""" |
| 29 | + # Get the directories (i.e. builds) from the GitHub Pages branch |
| 30 | + try: |
| 31 | + builds = set(get_branch_contents(ref)) |
| 32 | + except CalledProcessError: |
| 33 | + builds = set() |
| 34 | + logging.warning(f"Cannot get {ref} contents") |
| 35 | + |
| 36 | + # Add and remove from the list of builds |
| 37 | + if add: |
| 38 | + builds.add(add) |
| 39 | + if remove: |
| 40 | + assert remove in builds, f"Build '{remove}' not in {sorted(builds)}" |
| 41 | + builds.remove(remove) |
| 42 | + |
| 43 | + # Get a sorted list of tags |
| 44 | + tags = get_sorted_tags_list() |
| 45 | + |
| 46 | + # Make the sorted versions list from main branches and tags |
| 47 | + versions: List[str] = [] |
| 48 | + for version in ["master", "main"] + tags: |
| 49 | + if version in builds: |
| 50 | + versions.append(version) |
| 51 | + builds.remove(version) |
| 52 | + |
| 53 | + # Add in anything that is left to the bottom |
| 54 | + versions += sorted(builds) |
| 55 | + print(f"Sorted versions: {versions}") |
| 56 | + return versions |
| 57 | + |
| 58 | + |
| 59 | +def write_json(path: Path, repository: str, versions: str): |
| 60 | + org, repo_name = repository.split("/") |
| 61 | + struct = [ |
| 62 | + dict(name=version, url=f"https://{org}.github.io/{repo_name}/{version}/") |
| 63 | + for version in versions |
| 64 | + ] |
| 65 | + text = json.dumps(struct, indent=2) |
| 66 | + print(f"JSON switcher:\n{text}") |
| 67 | + path.write_text(text) |
| 68 | + |
| 69 | + |
| 70 | +def main(args=None): |
| 71 | + parser = ArgumentParser( |
| 72 | + description="Make a versions.txt file from gh-pages directories" |
| 73 | + ) |
| 74 | + parser.add_argument( |
| 75 | + "--add", |
| 76 | + help="Add this directory to the list of existing directories", |
| 77 | + ) |
| 78 | + parser.add_argument( |
| 79 | + "--remove", |
| 80 | + help="Remove this directory from the list of existing directories", |
| 81 | + ) |
| 82 | + parser.add_argument( |
| 83 | + "repository", |
| 84 | + help="The GitHub org and repository name: ORG/REPO", |
| 85 | + ) |
| 86 | + parser.add_argument( |
| 87 | + "output", |
| 88 | + type=Path, |
| 89 | + help="Path of write switcher.json to", |
| 90 | + ) |
| 91 | + args = parser.parse_args(args) |
| 92 | + |
| 93 | + # Write the versions file |
| 94 | + versions = get_versions("origin/gh-pages", args.add, args.remove) |
| 95 | + write_json(args.output, args.repository, versions) |
| 96 | + |
| 97 | + |
| 98 | +if __name__ == "__main__": |
| 99 | + main() |
0 commit comments