Skip to content

Conversation

@AryanVBW
Copy link

Add automated professional changelog generation to release workflow
This PR updates the release workflow to automatically generate professional, emoji-free changelogs based on commit history.

Changes

  • Disable default changelog parsing: The pypi-auto-publish action's built-in parser is disabled in favor of a more customizable solution.
  • Add Changelog Generator: Uses mikepenz/release-changelog-builder-action with mode: 'COMMIT'.
  • Custom Categorization: Configured regex patterns to accurately categorize commits based on this repository's history:
    • Features: Add, Introduce, Expose, Support, New, Feat, Allow, Implement, Enable
    • Bug Fixes: Fix, Correct, Resolve, Patch, Bug
    • Documentation: Doc, Update README, Clarify
    • Maintenance: Remove, Modify, Refactor, Update, Bump, Misc, Chore, Internal
  • Update Release: Uses softprops/action-gh-release to append the generated changelog to the GitHub Release body.

This ensures that future releases have detailed, well-organized release notes without manual intervention.
@alimuldal @Conchylicultor @reddragon

- Disable default changelog parsing in pypi-auto-publish
- Add 'Generate Changelog' step using mikepenz/release-changelog-builder-action
- Configure changelog builder with regex-based categories derived from commit history (Features, Bug Fixes, Documentation, Maintenance)
- Add 'Update Release' step to append changelog to GitHub Release
@AryanVBW AryanVBW force-pushed the feature/automated-changelog branch from d11aa85 to 9d26b4d Compare November 27, 2025 08:43
- Pin mikepenz/release-changelog-builder-action to commit SHA 32e3c96
- Upgrade softprops/action-gh-release from v1 to v2.4.2
- Pin softprops/action-gh-release to commit SHA 5be0e66

These changes improve supply-chain security and ensure compatibility with actively maintained action versions.
@AryanVBW AryanVBW force-pushed the feature/automated-changelog branch from 9d26b4d to e81240d Compare November 27, 2025 08:45
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