scripts/release.py: add script to help releasing

csernazs · csernazs · commit 584ff0e46b84 · 2021-10-18T19:18:19.000+02:00
This will do git tagging and changelog generation and others, but does not
push anything to anywhere. Also, no pypi upload (yet!).
diff --git a/doc/conf.py b/doc/conf.py
@@ -60,7 +60,7 @@
 # The short X.Y version.
 version = '1.0.1'
 # The full version, including alpha/beta/rc tags.
-release = '1.0.1'
+release = version
 
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.
diff --git a/scripts/release.py b/scripts/release.py
@@ -0,0 +1,84 @@
+#!/usr/bin/env python3
+
+import argparse
+import re
+import subprocess
+import sys
+from pathlib import Path
+from typing import List
+
+
+class UsageError(Exception):
+    pass
+
+
+def parse_version():
+    with Path("setup.py").open() as infile:
+        for line in infile:
+            if m := re.match(r"VERSION\s*=\s*\"(.*)\"$", line):
+                return m.groups()[0]
+
+
+def bump_version(path: Path, prefixes: List[str], current_version: str, new_version: str):
+    prefixes = tuple(prefixes)
+    lines = []
+    for line in path.open():
+        if line.startswith(prefixes):
+            line = line.replace(current_version, new_version)
+        lines.append(line)
+
+    path.write_text("".join(lines))
+
+
+def git(*args):
+    return subprocess.check_call(["git"] + list(args))
+
+
+def make(*args):
+    return subprocess.check_call(["make"] + list(args))
+
+
+def check_changelog():
+    old_changelog = Path("CHANGES.rst").read_text()
+    make("changes")
+    new_changelog = Path("CHANGES.rst").read_text()
+    if old_changelog == new_changelog:
+        raise UsageError("No new changelog entries")
+
+
+def main():
+    parser = argparse.ArgumentParser()
+    parser.add_argument("new_version", help="Version to release")
+
+    args = parser.parse_args()
+    new_version: str = args.new_version
+
+    current_version = parse_version()
+    if current_version is None:
+        raise UsageError("Unable to parse version")
+
+    print(f"Current version: {current_version}")
+
+    if current_version == new_version:
+        raise UsageError("Current version is the same as new version")
+
+    check_changelog()
+
+    bump_version(Path("setup.py"), ["VERSION"], current_version, new_version)
+    bump_version(Path("doc/conf.py"), ["version"], current_version, new_version)
+
+    git("add", "setup.py", "doc/conf.py")
+    git("commit", "-m", "Version bump to {}".format(new_version))
+    git("tag", new_version)
+    make("changes")
+    git("add", "CHANGES.rst")
+    git("commit", "-m", "CHANGES.rst: add release notes for {}".format(new_version))
+    git("tag", "-f", new_version)
+
+
+if __name__ == "__main__":
+    try:
+        main()
+    except UsageError as err:
+        print(f"ERROR: {err}", file=sys.stderr)
+        sys.exit(1)
diff --git a/setup.py b/setup.py
@@ -2,12 +2,12 @@
 
 from setuptools import setup, find_packages
 
-
+VERSION = "1.0.1"
 DESCRIPTION = open("README.md").read()
 
 setup(
     name="pytest_httpserver",
-    version="1.0.1",
+    version=VERSION,
     url="https://www.github.com/csernazs/pytest-httpserver",
     packages=find_packages(),
     package_data={"pytest_httpserver": ["py.typed"]},
