Skip to content

Conversation

@STRML
Copy link
Collaborator

@STRML STRML commented Dec 14, 2025

Summary

Improves the automatic changelog generation for releases to produce more useful and organized release notes.

Changes

.github/changelog-configuration.json:

  • Added more categories: Breaking Changes, New Features, Bug Fixes, Performance, Documentation, Tests, Internal Changes
  • Better PR template with bold titles, clickable links, and author attribution
  • Label extractors for conventional commit prefixes (fix:, feat:, docs:, chore:, test:, perf:, refactor:)
  • Transformers to strip commit prefixes from titles for cleaner output
  • Expanded ignore list for stale/invalid/duplicate PRs

.github/release.yml:

  • Consistent categories with emojis matching the changelog config
  • Added Performance, Documentation, and Tests sections

.github/workflows/changelog.yml:

  • Updated to actions/checkout@v4
  • Updated to mikepenz/release-changelog-builder-action@v5
  • Replaced deprecated actions/create-release@v1 with softprops/action-gh-release@v2
  • Added fetch-depth: 0 for full git history (needed for changelog generation)

New Labels Created

Also created missing labels in the repo to support categorization:

  • fix, feature, performance, breaking-change, chore, ignore_changelog

Test Plan

  • Next release will use these configurations automatically
  • PRs can be categorized by either labels or conventional commit prefixes in titles

- Update changelog-configuration.json with more categories (Breaking Changes,
  New Features, Bug Fixes, Performance, Documentation, Tests, Internal Changes)
- Add conventional commit prefix detection (fix:, feat:, docs:, etc.)
- Improve PR template with bold titles, clickable links, and author attribution
- Update release.yml categories to match changelog config
- Upgrade actions to latest versions (checkout@v4, release-changelog-builder@v5,
  softprops/action-gh-release@v2)
- Replace deprecated actions/create-release@v1
@STRML STRML merged commit 6b78db9 into master Dec 14, 2025
4 checks passed
@STRML STRML deleted the chore/improve-changelog-action branch December 14, 2025 22:12
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants