54 lines
2.4 KiB
Python
54 lines
2.4 KiB
Python
"""A release: a semver version x.y.z the human cuts. Its tag is `v<x.y.z>`, and once cut, CHANGELOG.md heads its section `## x.y.z - YYYY-MM-DD`. Every pattern for a release lives here."""
|
|
import re
|
|
|
|
from failure import Failure
|
|
from git_cli import git_repo
|
|
|
|
Release = tuple[int, int, int]
|
|
VERSION = r"[0-9]+\.[0-9]+\.[0-9]+"
|
|
# The digits of a dated heading's year, month and day, which DATED and dated_heading_pattern each render.
|
|
DATE_DIGITS = (4, 2, 2)
|
|
DATED = re.compile(rf"({VERSION}) - " + "-".join(f"[0-9]{{{digits}}}" for digits in DATE_DIGITS))
|
|
TAG = re.compile(rf"v({VERSION})")
|
|
|
|
|
|
def release_of(version: str) -> Release:
|
|
"""The release a VERSION-shaped version names."""
|
|
major, minor, patch = (int(part) for part in version.split("."))
|
|
return major, minor, patch
|
|
|
|
|
|
def version(release: Release) -> str:
|
|
"""The version a release names, such as 0.2.1: release_of's inverse."""
|
|
return ".".join(map(str, release))
|
|
|
|
|
|
def parsed(text: str) -> Release | None:
|
|
"""The release text names as a bare version, such as a CHANGELOG.md heading's `0.2.1`; None for any other text."""
|
|
return release_of(text) if re.fullmatch(VERSION, text) else None
|
|
|
|
|
|
def tagged(tag: str | None) -> Release | None:
|
|
"""The release a `v<x.y.z>` tag names; None for no tag, or a tag that names none."""
|
|
named = TAG.fullmatch(tag) if tag else None
|
|
return release_of(named[1]) if named else None
|
|
|
|
|
|
def dated(heading: str) -> Release | None:
|
|
"""The release a dated CHANGELOG.md heading, such as `0.2.1 - 2026-10-03`, names; None for any other heading, an undated one included."""
|
|
named = DATED.fullmatch(heading)
|
|
return release_of(named[1]) if named else None
|
|
|
|
|
|
def dated_heading_pattern(release: Release) -> str:
|
|
"""A basic regular expression, as `git log -G` takes, matching release's dated heading line in CHANGELOG.md and no other."""
|
|
return "^## " + re.escape(version(release)) + " - " + "-".join("[0-9]" * digits for digits in DATE_DIGITS) + "$"
|
|
|
|
|
|
def newest_tag(cwd: str | None = None, merged_into: str | None = None, run: git_repo.Git = git_repo.git) -> str | None | Failure:
|
|
"""The newest `v*` tag, read in cwd, else in the current directory, and merged into merged_into where it is given; None when there is none."""
|
|
# Sorts v1.0.0-rc.1 below v1.0.0.
|
|
merged = ["--merged", merged_into] if merged_into else []
|
|
tags = run("-c", "versionsort.suffix=-", "tag", "--list", "v*", *merged, "--sort=-v:refname", cwd=cwd)
|
|
return tags if isinstance(tags, Failure) else next(iter(tags.split()), None)
|