release-note-readiness-desk 0.1.0

Local CLI and desktop checker for release note readiness gaps

Release Note Readiness Desk

Release Note Readiness Desk checks changelog drafts, PR summaries, and release-note copy for gaps that usually cause avoidable release confusion: missing migration steps, unclear customer impact, vague bullets, unresolved placeholders, absent validation evidence, and missing rollback notes.

It runs locally as a CLI or a small Tkinter desktop app. There are no runtime dependencies.

Install

python3 -m pip install release-note-readiness-desk

CLI

release-note-readiness examples/release-draft.md
release-note-readiness examples/release-draft.md --format html --output readiness.html
release-note-readiness CHANGELOG.md --fail-under 80 --fail-on-high

Read from stdin:

cat CHANGELOG.md | release-note-readiness --format json

Desktop App

release-note-readiness-gui

Paste a draft, click Check, then copy or save the Markdown report.

What It Checks

• Breaking or high-risk changes without migration guidance
• Risky changes without customer impact language
• Missing validation or rollout evidence
• Missing rollback, revert, or feature-flag notes
• Draft placeholders such as TODO or TBD
• Vague entries like "minor updates" or "various fixes"
• Missing standard release-note categories

Development

python3 -m unittest discover -s tests
python3 -m build --no-isolation
python3 -m twine check dist/*

License

MIT