Skip to content

~95% on SimpleQA (e.g. Qwen3.6-27B on a 3090). Supports all local and cloud LLMs (llama.cpp, Ollama, Google, ...). 10+ search engines - arXiv, PubMed, your private documents. Everything Local & Encrypted.

3.9 KB
Raw Blame
#!/usr/bin/env python3
"""Detect pending breaking changelog fragments and refuse non-major releases.

Used by ``version_check.yml`` (release-type selection, post-bump check and
closing a stale bump PR) and ``release.yml`` (pre-publish guard).

Fragment detection mirrors what towncrier renders, not a shell glob: a
dot-prefixed ``changelog.d/.123.breaking.md`` or a counter-suffixed
``123.breaking.2.md`` still lands under "Breaking Changes", so it must
count here too. See ``towncrier_category`` in
``.pre-commit-hooks/_changelog_fragments.py``.

Subcommands:

``pending``
    Print every pending breaking fragment, one per line. Exit 0 whether or
    not any exist; any other exit status is an error and callers must treat
    it as a failure (never as "nothing pending").

``version VERSION``
    Exit 1 when breaking fragments are pending and VERSION is not a major
    release: ``N.0.0`` for N >= 1, or ``0.N.0`` while still pre-1.0. A
    patch (``1.10.8``) or minor (``1.11.0``) release would publish breaking
    notes under a compatible-looking version. Exit 0 otherwise.
"""

from __future__ import annotations

import argparse
import re
import sys
from pathlib import Path

sys.path.insert(
    0, str(Path(__file__).resolve().parents[2] / ".pre-commit-hooks")
)

from _changelog_fragments import towncrier_fragments  # noqa: E402

BREAKING = "breaking"
_VERSION_RE = re.compile(
    r"v?([0-9]+)\.([0-9]+)\.([0-9]+)"
    r"(?:[-_.]?(?:alpha|a|beta|b|preview|pre|c|rc)[-_.]?[0-9]*)?"
    r"(?:[-_.]?dev[-_.]?[0-9]*)?"
)


def pending_breaking(changelog_dir, pyproject):
    """Return the sorted names towncrier would render as breaking changes."""
    found = towncrier_fragments(changelog_dir, pyproject)
    return sorted(name for name, cat in found.items() if cat == BREAKING)


def is_major_release(version):
    """True for ``N.0.0`` (N >= 1) or ``0.N.0`` (N >= 1), pre-release suffixes allowed.

    Anything unparseable is refused (returns False) so the guard fails closed.
    """
    match = _VERSION_RE.fullmatch(version.strip().lower())
    if not match:
        return False
    try:
        major, minor, patch = (int(group) for group in match.groups())
    except ValueError:
        # A ≥4301-digit component exceeds CPython's int() string
        # conversion limit and the conversion itself raises; refuse via
        # the documented False path instead of escaping as a traceback,
        # so the workflow still sees the designed ::error:: annotation.
        return False
    if patch != 0:
        return False
    if major >= 1:
        return minor == 0
    return minor >= 1


def main(argv=None):
    parser = argparse.ArgumentParser(description=__doc__.splitlines()[0])
    parser.add_argument("--changelog-dir", default="changelog.d")
    parser.add_argument("--pyproject", default="pyproject.toml")
    sub = parser.add_subparsers(dest="command", required=True)
    sub.add_parser("pending", help="list pending breaking fragments")
    check = sub.add_parser(
        "version",
        help="refuse a non-major VERSION while breaking fragments are pending",
    )
    check.add_argument("version")
    args = parser.parse_args(argv)

    breaking = pending_breaking(args.changelog_dir, args.pyproject)
    if args.command == "pending":
        for name in breaking:
            print(name)
        return 0

    if breaking and not is_major_release(args.version):
        print(
            f"::error::Version {args.version} is not a major release, but "
            f"breaking changelog fragments are pending: {', '.join(breaking)}. "
            "Breaking changes need N.0.0 (or 0.N.0 before 1.0); see "
            "docs/RELEASE_GUIDE.md."
        )
        return 1
    if breaking:
        print(
            f"Version {args.version} is a major release; breaking fragments allowed."
        )
    else:
        print("No breaking changelog fragments are pending.")
    return 0


if __name__ == "__main__":
    sys.exit(main())