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

@@ -176,13 +176,14 @@ Enable changelog validation to enforce that code changes include `Unreleased` ch
badge-url: ${{ steps.coverage.outputs.badge-url }}
enable-changelog-gate: true
changelog-gate-mode: strict
changelog-gate-required-for: 'code,behavior,security,workflow,tooling'
changelog-gate-required-for: "code,behavior,security,workflow,tooling"
changelog-gate-allow-docs-only: true
changelog-gate-docs-globs: 'docs/**,**.md,**.txt,**.rst'
changelog-gate-skip-labels: 'skip-changelog'
changelog-gate-docs-globs: "docs/**,**.md,**.txt,**.rst"
changelog-gate-skip-labels: "skip-changelog"
```
The gate automatically:
- Parses diffs to detect docs-only PRs (skips requirement for doc-only changes)
- Counts `Unreleased` additions using section-aware parsing (ignores edits outside the section)
- Checks PR labels for skip exemptions (for example, `skip-changelog`)