Skip to content

Commit 662ec35

Browse files
committed
update docs versioning
1 parent d1a8b8b commit 662ec35

1 file changed

Lines changed: 10 additions & 1 deletion

File tree

scripts/update_docs_version.py

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,20 +2,29 @@
22
from __future__ import annotations
33

44
from pathlib import Path
5+
import re
56
import tomllib
67

78

89
ROOT = Path(__file__).resolve().parents[1]
910
PYPROJECT = ROOT / "pyproject.toml"
1011
GENERATED_MD = ROOT / "docs" / "_generated_version.md"
1112
GENERATED_SVG = ROOT / "docs" / "_generated_version.svg"
13+
PRE_RELEASE_PATTERN = re.compile(r"^(\d+(?:\.\d+)*)(?:a|b|rc)\d+.*$")
1214

1315

1416
def read_version() -> str:
1517
data = tomllib.loads(PYPROJECT.read_text(encoding="utf-8"))
1618
return data["tool"]["poetry"]["version"]
1719

1820

21+
def normalize_release_version(version: str) -> str:
22+
match = PRE_RELEASE_PATTERN.match(version)
23+
if match:
24+
return match.group(1)
25+
return version
26+
27+
1928
def build_badge_svg(version: str) -> str:
2029
label = "Version"
2130
label_width = 60
@@ -69,7 +78,7 @@ def write_generated(version: str) -> bool:
6978

7079

7180
def main() -> None:
72-
version = read_version()
81+
version = normalize_release_version(read_version())
7382
changed = write_generated(version)
7483
if changed:
7584
print(f"Updated docs/_generated_version.* to version {version}")

0 commit comments

Comments
 (0)