Repository navigation
Expand file tree
/
Copy pathpromote_unstable_docs_docusaurus.py
More file actions
117 lines (94 loc) · 5 KB
/
Copy pathpromote_unstable_docs_docusaurus.py
File metadata and controls
117 lines (94 loc) · 5 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
"""
This script promotes an unstable documentation version to a stable version at the time of a new Haystack release.
To understand how unstable doc versions are created, see create_unstable_docs_docusaurus.py.
"""
import argparse
import json
import os
import re
import shutil
import sys
VERSION_VALIDATOR = re.compile(r"^[0-9]+\.[0-9]+$")
MAX_STABLE_VERSIONS = 5
if __name__ == "__main__":
parser = argparse.ArgumentParser()
parser.add_argument("-v", "--version", help="The version to promote to stable (e.g. 2.20).", required=True)
args = parser.parse_args()
if VERSION_VALIDATOR.match(args.version) is None:
sys.exit("Version must be formatted like so <major>.<minor>")
target_version = f"{args.version}" # e.g., "2.20" - the target release version
major, minor = args.version.split(".")
target_unstable = f"{target_version}-unstable" # e.g., "2.20-unstable"
previous_stable = f"{major}.{int(minor) - 1}" # e.g., "2.19" - previous stable release
versions = [
folder.replace("version-", "")
for folder in os.listdir("docs-website/versioned_docs")
if os.path.isdir(os.path.join("docs-website/versioned_docs", folder))
]
if target_version in versions:
sys.exit(f"{target_version} already exists (already released). Aborting.")
if target_unstable not in versions:
sys.exit(f"Can't find version {target_unstable} to promote to {target_version}")
print(f"Promoting unstable version {target_unstable} to stable version {target_version}")
### Docusaurus updates
# move versioned_docs/version-target_unstable to versioned_docs/version-target_version
shutil.move(
f"docs-website/versioned_docs/version-{target_unstable}",
f"docs-website/versioned_docs/version-{target_version}",
)
# move reference_versioned_docs/version-target_unstable to reference_versioned_docs/version-target_version
shutil.move(
f"docs-website/reference_versioned_docs/version-{target_unstable}",
f"docs-website/reference_versioned_docs/version-{target_version}",
)
# move versioned_sidebars/version-target_unstable-sidebars.json
# to versioned_sidebars/version-target_version-sidebars.json
shutil.move(
f"docs-website/versioned_sidebars/version-{target_unstable}-sidebars.json",
f"docs-website/versioned_sidebars/version-{target_version}-sidebars.json",
)
# move reference_versioned_sidebars/version-target_unstable-sidebars.json
# to reference_versioned_sidebars/version-target_version-sidebars.json
shutil.move(
f"docs-website/reference_versioned_sidebars/version-{target_unstable}-sidebars.json",
f"docs-website/reference_versioned_sidebars/version-{target_version}-sidebars.json",
)
# replace unstable version with stable version in versions.json
with open("docs-website/versions.json") as f:
versions_list = json.load(f)
versions_list[versions_list.index(target_unstable)] = target_version
with open("docs-website/versions.json", "w") as f:
json.dump(versions_list, f)
# replace unstable version with stable version in reference_versions.json
with open("docs-website/reference_versions.json") as f:
reference_versions_list = json.load(f)
reference_versions_list[reference_versions_list.index(target_unstable)] = target_version
with open("docs-website/reference_versions.json", "w") as f:
json.dump(reference_versions_list, f)
# in docusaurus.config.js, replace previous stable version with the target version
with open("docs-website/docusaurus.config.js") as f:
config = f.read()
config = config.replace(f"lastVersion: '{previous_stable}'", f"lastVersion: '{target_version}'") # "2.19" -> "2.20"
with open("docs-website/docusaurus.config.js", "w") as f:
f.write(config)
# regenerate vercel.json redirects for inactive versions (those beyond the top MAX_STABLE_VERSIONS)
with open("docs-website/versions.json") as f:
updated_versions = json.load(f)
stable_versions = [v for v in updated_versions if not v.endswith("-unstable")]
inactive_versions = stable_versions[MAX_STABLE_VERSIONS:]
redirects = []
for v in inactive_versions:
redirects.append({"source": f"/docs/{v}/:slug*", "destination": "/docs/:slug*", "permanent": True})
redirects.append({"source": f"/reference/{v}/:slug*", "destination": "/reference/:slug*", "permanent": True})
with open("docs-website/vercel.json") as f:
vercel_config = json.load(f)
existing_redirects = vercel_config.get("redirects", [])
existing_sources = {r.get("source") for r in existing_redirects}
for r in redirects:
if r["source"] not in existing_sources:
existing_redirects.append(r)
vercel_config["redirects"] = existing_redirects
with open("docs-website/vercel.json", "w") as f:
json.dump(vercel_config, f, indent=2)
f.write("\n")
print(f"Updated vercel.json with {len(redirects)} redirect(s) for inactive versions: {inactive_versions}")