开始使用
Check Your CHANGELOG Before You Ship It

Check Your CHANGELOG Before You Ship It

Ship the changelog your users can actually read.
#工程
评分
需要更多评价
订单数
0
如何使用
下载

Check a CHANGELOG.md against the Keep a Changelog convention before you ship: catch a missing Unreleased section, malformed version headings, impossible dates, duplicate versions, versions out of newest-first order, empty or unknown categories, missing link references, versions with no categories, and prose lines that are not bullet entries. Deterministic pass/fail results plus JSON and Markdown reports. Reads the file as text only, never edits it, never opens a network connection. Twelve deterministic rules. CHANGELOG parser (title, Unreleased section, version headings, ISO dates, categories, link references). Version heading format check against ## [x.y.z] - YYYY-MM-DD. Real calendar-date validation (2026-02-30 fails, 2026-02-28 passes). Duplicate-version and newest-first ordering checks. Empty and unknown category checks. Missing link-reference check for released versions. Critical vs warning severities with CI-friendly exit codes. JSON and Markdown reports. No external dependencies. Requirements: Python 3.9+; a CHANGELOG.md. Limitations: Checks the CHANGELOG.md as text only; it cannot confirm the entries are complete or true — only a human who knows the release can.