Skip to content

Changelog

changelog

Audit checks for changelog (2 checks, 5 pts).

check_gitcliff_config(project)

Check 31: [tool.git-cliff] section in pyproject.toml.

Source code in packages/axm-init/src/axm_init/checks/changelog.py 
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
def check_gitcliff_config(project: Path) -> CheckResult:
    """Check 31: [tool.git-cliff] section in pyproject.toml."""
    path = project / "pyproject.toml"
    if not path.exists():
        return CheckResult(
            name="changelog.gitcliff",
            category="changelog",
            passed=False,
            weight=3,
            message="pyproject.toml not found",
            details=[],
            fix="Create pyproject.toml with [tool.git-cliff] section.",
        )
    try:
        with path.open("rb") as f:
            data = tomllib.load(f)
    except Exception:
        return CheckResult(
            name="changelog.gitcliff",
            category="changelog",
            passed=False,
            weight=3,
            message="pyproject.toml unparsable",
            details=[],
            fix="Fix TOML syntax and add [tool.git-cliff] section.",
        )
    if "git-cliff" not in data.get("tool", {}):
        return CheckResult(
            name="changelog.gitcliff",
            category="changelog",
            passed=False,
            weight=3,
            message="No [tool.git-cliff] config found",
            details=["git-cliff auto-generates CHANGELOG from conventional commits"],
            fix=(
                "Add [tool.git-cliff.changelog] and"
                " [tool.git-cliff.git] to pyproject.toml."
            ),
        )
    return CheckResult(
        name="changelog.gitcliff",
        category="changelog",
        passed=True,
        weight=3,
        message="git-cliff configured",
        details=[],
        fix="",
    )

check_no_manual_changelog(project)

Check 32: no manual CHANGELOG.md (git-cliff auto-generates).

Source code in packages/axm-init/src/axm_init/checks/changelog.py 
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
def check_no_manual_changelog(project: Path) -> CheckResult:
    """Check 32: no manual CHANGELOG.md (git-cliff auto-generates)."""
    if (project / "CHANGELOG.md").exists():
        return CheckResult(
            name="changelog.no_manual",
            category="changelog",
            passed=False,
            weight=2,
            message="Manual CHANGELOG.md found",
            details=["git-cliff should auto-generate the changelog"],
            fix=(
                "Delete CHANGELOG.md - git-cliff generates"
                " it from conventional commits."
            ),
        )
    return CheckResult(
        name="changelog.no_manual",
        category="changelog",
        passed=True,
        weight=2,
        message="No manual CHANGELOG.md",
        details=[],
        fix="",
    )