123 lines
3.7 KiB
Python
123 lines
3.7 KiB
Python
"""
|
|
Invoke development tasks.
|
|
"""
|
|
import argparse
|
|
from pathlib import Path
|
|
from subprocess import call
|
|
from subprocess import check_call
|
|
from subprocess import check_output
|
|
|
|
from colorama import Fore
|
|
from colorama import init
|
|
|
|
|
|
def announce(version):
|
|
"""Generates a new release announcement entry in the docs."""
|
|
# Get our list of authors
|
|
stdout = check_output(["git", "describe", "--abbrev=0", "--tags"])
|
|
stdout = stdout.decode("utf-8")
|
|
last_version = stdout.strip()
|
|
|
|
stdout = check_output(
|
|
["git", "log", "{}..HEAD".format(last_version), "--format=%aN"]
|
|
)
|
|
stdout = stdout.decode("utf-8")
|
|
|
|
contributors = set(stdout.splitlines())
|
|
|
|
template_name = (
|
|
"release.minor.rst" if version.endswith(".0") else "release.patch.rst"
|
|
)
|
|
template_text = (
|
|
Path(__file__).parent.joinpath(template_name).read_text(encoding="UTF-8")
|
|
)
|
|
|
|
contributors_text = (
|
|
"\n".join("* {}".format(name) for name in sorted(contributors)) + "\n"
|
|
)
|
|
text = template_text.format(version=version, contributors=contributors_text)
|
|
|
|
target = Path(__file__).parent.joinpath(
|
|
"../doc/en/announce/release-{}.rst".format(version)
|
|
)
|
|
target.write_text(text, encoding="UTF-8")
|
|
print(f"{Fore.CYAN}[generate.announce] {Fore.RESET}Generated {target.name}")
|
|
|
|
# Update index with the new release entry
|
|
index_path = Path(__file__).parent.joinpath("../doc/en/announce/index.rst")
|
|
lines = index_path.read_text(encoding="UTF-8").splitlines()
|
|
indent = " "
|
|
for index, line in enumerate(lines):
|
|
if line.startswith("{}release-".format(indent)):
|
|
new_line = indent + target.stem
|
|
if line != new_line:
|
|
lines.insert(index, new_line)
|
|
index_path.write_text("\n".join(lines) + "\n", encoding="UTF-8")
|
|
print(
|
|
f"{Fore.CYAN}[generate.announce] {Fore.RESET}Updated {index_path.name}"
|
|
)
|
|
else:
|
|
print(
|
|
f"{Fore.CYAN}[generate.announce] {Fore.RESET}Skip {index_path.name} (already contains release)"
|
|
)
|
|
break
|
|
|
|
check_call(["git", "add", str(target)])
|
|
|
|
|
|
def regen():
|
|
"""Call regendoc tool to update examples and pytest output in the docs."""
|
|
print(f"{Fore.CYAN}[generate.regen] {Fore.RESET}Updating docs")
|
|
check_call(["tox", "-e", "regen"])
|
|
|
|
|
|
def fix_formatting():
|
|
"""Runs pre-commit in all files to ensure they are formatted correctly"""
|
|
print(
|
|
f"{Fore.CYAN}[generate.fix linting] {Fore.RESET}Fixing formatting using pre-commit"
|
|
)
|
|
call(["pre-commit", "run", "--all-files"])
|
|
|
|
|
|
def check_links():
|
|
"""Runs sphinx-build to check links"""
|
|
print(f"{Fore.CYAN}[generate.check_links] {Fore.RESET}Checking links")
|
|
check_call(["tox", "-e", "docs-checklinks"])
|
|
|
|
|
|
def pre_release(version):
|
|
"""Generates new docs, release announcements and creates a local tag."""
|
|
announce(version)
|
|
regen()
|
|
changelog(version, write_out=True)
|
|
fix_formatting()
|
|
check_links()
|
|
|
|
msg = "Preparing release version {}".format(version)
|
|
check_call(["git", "commit", "-a", "-m", msg])
|
|
|
|
print()
|
|
print(f"{Fore.CYAN}[generate.pre_release] {Fore.GREEN}All done!")
|
|
print()
|
|
print(f"Please push your branch and open a PR.")
|
|
|
|
|
|
def changelog(version, write_out=False):
|
|
if write_out:
|
|
addopts = []
|
|
else:
|
|
addopts = ["--draft"]
|
|
check_call(["towncrier", "--yes", "--version", version] + addopts)
|
|
|
|
|
|
def main():
|
|
init(autoreset=True)
|
|
parser = argparse.ArgumentParser()
|
|
parser.add_argument("version", help="Release version")
|
|
options = parser.parse_args()
|
|
pre_release(options.version)
|
|
|
|
|
|
if __name__ == "__main__":
|
|
main()
|