#!/usr/bin/env python3 from __future__ import annotations import argparse import datetime import json import os import re import subprocess import sys from pathlib import Path from typing import Tuple parser = argparse.ArgumentParser(description="Tags and releases the next version of this project.") parser.add_argument("tag", help="Semantic version number to use as the tag.") parser.add_argument("-e", "--edit", action="store_true", help="Force edits of git commits.") parser.add_argument("-n", "--dry-run", action="store_true", help="Don't modify files.") parser.add_argument("-v", "--verbose", action="store_true", help="Print debug information.") PROJECT_DIR = Path(__file__).parent.parent # Project directory relative to this script. CHANGELOG_PATH = PROJECT_DIR / "CHANGELOG.md" def parse_changelog(args: argparse.Namespace) -> Tuple[str, str]: """Return an updated changelog and and the list of changes.""" match = re.match( pattern=r"(.*?## \[Unreleased]\n)(.+?\n)(\n*## \[.*)", string=CHANGELOG_PATH.read_text(encoding="utf-8"), flags=re.DOTALL, ) assert match header, changes, tail = match.groups() tagged = "\n## [%s] - %s\n%s" % ( args.tag, datetime.date.today().isoformat(), changes, ) if args.verbose: print(tagged) return "".join((header, tagged, tail)), changes VERSION_SOURCE = """\ {head} #define TCOD_MAJOR_VERSION {major} #define TCOD_MINOR_VERSION {minor} #define TCOD_PATCHLEVEL {patch} #define TCOD_STRVERSION "{tag}" {tail}""" def update_version_header(args: argparse.Namespace) -> None: """Update version.h to use the given tag.""" VERSION_HEADER = Path("src/libtcod/version.h") match = re.match( pattern=r"(?P.*?)\n#define TCOD_MAJOR_VERSION.*?TCOD_STRVERSION[^\n]*\n(?P.*)", string=VERSION_HEADER.read_text(encoding="utf-8"), flags=re.DOTALL, ) assert match format_args = {"tag": args.tag} format_args.update(match.groupdict()) match = re.match( pattern=r"(?P[0-9]+)\.(?P[0-9]+)\.(?P[0-9]+)", string=args.tag, ) assert match format_args.update(match.groupdict()) source = VERSION_SOURCE.format(**format_args) if not args.dry_run: VERSION_HEADER.write_text(source, encoding="utf-8") def update_vcpkg_manifest(args: argparse.Namespace) -> None: """Update the version on the vcpkg.json manifest.""" with open("vcpkg.json", "r", encoding="utf-8") as f: vcpkg_manifest = json.load(f) vcpkg_manifest["version-semver"] = args.tag if not args.dry_run: with open("vcpkg.json", "w", encoding="utf-8") as f: json.dump(vcpkg_manifest, f, indent=2) def replace_unreleased_tags(tag: str, dry_run: bool, path: Path) -> None: """Replace "unreleased" version tags with the provided tag. Such as the following examples: ".. versionadded:: unreleased" -> ".. versionadded:: " "@versionadded{Unreleased}" -> "@versionadded{}" """ match = re.match(r"\d+\.\d+", tag) # Get "major.minor" version. assert match short_tag = match.group() for directory, _, files in os.walk(path): for filename in files: file = Path(directory, filename) if file.suffix not in {".c", ".cpp", ".h", ".hpp"}: continue text = file.read_text(encoding="utf-8") new_text = re.sub( r":: *unreleased", rf":: {short_tag}", text, flags=re.IGNORECASE, ) new_text = re.sub( r"@versionadded{ *unreleased *}", rf"@versionadded{{{short_tag}}}", new_text, flags=re.IGNORECASE, ) if text != new_text: print(f"Update tags in {file}") if not dry_run: file.write_text(new_text, encoding="utf-8") def main() -> None: if len(sys.argv) == 1: parser.print_help(sys.stderr) sys.exit(1) args = parser.parse_args() if args.verbose: print(args) update_version_header(args) new_changelog, changes = parse_changelog(args) update_vcpkg_manifest(args) replace_unreleased_tags(args.tag, args.dry_run, PROJECT_DIR / "src") if not args.dry_run: CHANGELOG_PATH.write_text(new_changelog, encoding="utf-8") edit = ["-e"] if args.edit else [] subprocess.check_call( ["git", "commit", "-avm", f"Prepare {args.tag} release.", *edit], ) subprocess.check_call( ["git", "tag", args.tag, "-a", "-m", f"{args.tag}\n\n{changes}", *edit], ) if __name__ == "__main__": main()