docs: refine changelog gate documentation formatting and descriptions

This commit is contained in:
Micheal Wilkinson
2026-03-21 13:51:07 +00:00
parent d4d911e6c7
commit 830e623fa9
3 changed files with 24 additions and 5 deletions

View File

@@ -13,6 +13,14 @@ A `### Breaking` section is used in addition to Keep a Changelog's standard sect
### Added
- Added changelog gate validation to `decorate-pr` action for enforcing changelog updates on qualifying code changes.
- Changelog gate modes: `strict` (fails job on violation) and `soft` (warns via PR comment).
- Docs-only PR exemption with customizable glob patterns for documentation files.
- PR label-based exemptions for changelog gate (example: `skip-changelog`).
- Precise diff parsing: validates only added lines within the Unreleased section.
- Gate decision outputs: `gate-passed`, `docs-only`, `unreleased-additions-count`, `gate-failure-reason` for reuse downstream.
- Integrated remediation guidance in PR comments showing how to add changelog entries.
### Changed
### Removed