Skip to content

chore(release): customise git-cliff release notes output#75

Merged
benner merged 1 commit into
mainfrom
chore/cliff-toml-release-notes
May 1, 2026
Merged

chore(release): customise git-cliff release notes output#75
benner merged 1 commit into
mainfrom
chore/cliff-toml-release-notes

Conversation

@benner
Copy link
Copy Markdown
Owner

@benner benner commented May 1, 2026

Default output includes ci/docs noise and bare SHAs with no links.
Filtering those types keeps release notes focused on user-visible changes,
short SHAs linked to GitHub commits aid traceability, and the new
contributors section surfaces first-time contributors automatically.

Add cliff.toml: skip docs/ci types, link 7-char SHAs to GitHub commits,
add first-time contributors section via GitHub API integration.
Pass GITHUB_TOKEN to git-cliff-action step and add pull-requests: read
permission so the contributor lookup succeeds in CI.

@github-actions
Copy link
Copy Markdown

github-actions Bot commented May 1, 2026

Coverage

Coverage Report (Δ +0.0%)
FileStmtsMissCoverMissing
src/git_commit_guard
   __init__.py3810100% 
TOTAL3810100% 

Default output includes ci/docs noise and bare SHAs with no links.
Filtering those types keeps release notes focused on user-visible changes,
short SHAs linked to GitHub commits aid traceability, and the new
contributors section surfaces first-time contributors automatically.

Add cliff.toml: skip docs/ci types, link 7-char SHAs to GitHub commits,
add first-time contributors section via GitHub API integration.
Pass GITHUB_TOKEN to git-cliff-action step and add pull-requests: read
permission so the contributor lookup succeeds in CI.

Signed-off-by: Nerijus Bendžiūnas <nerijus.bendziunas@gmail.com>
@benner benner force-pushed the chore/cliff-toml-release-notes branch from 23647da to 37004c0 Compare May 1, 2026 06:10
@benner benner marked this pull request as ready for review May 1, 2026 06:11
@benner benner merged commit bcf1d5d into main May 1, 2026
6 checks passed
@benner benner deleted the chore/cliff-toml-release-notes branch May 1, 2026 06:11
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant