File: bump_version_in_docs.py

package info (click to toggle)
python-semantic-release 10.3.1-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 3,112 kB
  • sloc: python: 36,523; sh: 340; makefile: 156
file content (44 lines) | stat: -rw-r--r-- 1,358 bytes parent folder | download
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
# ruff: noqa: T201, allow print statements in non-prod scripts
from __future__ import annotations

from os import getenv
from pathlib import Path
from re import compile as regexp

# Constants
PROJ_DIR = Path(__file__).resolve().parent.parent
DOCS_DIR = PROJ_DIR / "docs"
version_replace_pattern = regexp(r"\$(NEW_VERSION|{NEW_VERSION})")
tag_replace_pattern = regexp(r"\$(NEW_RELEASE_TAG|{NEW_RELEASE_TAG})")


def envsubst(filepath: Path, version: str, release_tag: str) -> None:
    file_content = filepath.read_text()

    found = False
    for pattern, replacement in [
        (version_replace_pattern, version),
        (tag_replace_pattern, release_tag),
    ]:
        if not found and (found := bool(pattern.search(file_content))):
            print(f"Applying envsubst to {filepath}")

        file_content = pattern.sub(replacement, file_content)

    filepath.write_text(file_content)


if __name__ == "__main__":
    new_release_tag = getenv("NEW_RELEASE_TAG")
    new_version = getenv("NEW_VERSION")

    if not new_release_tag:
        print("NEW_RELEASE_TAG environment variable is not set")
        exit(1)

    if not new_version:
        print("NEW_VERSION environment variable is not set")
        exit(1)

    for doc_file in DOCS_DIR.rglob("*.rst"):
        envsubst(filepath=doc_file, version=new_version, release_tag=new_release_tag)