ci: fix changelog creation and update contribution guide - #80
Open
lheppler wants to merge 4 commits into
Open
Conversation
Hanna-Shalamitskaya-EPAM
approved these changes
Jul 29, 2026
Hanna-Shalamitskaya-EPAM
left a comment
Hanna-Shalamitskaya-EPAM
left a comment
Contributor
There was a problem hiding this comment.
Looks good for me
The previously documented Conventional Commits convention prescribes a fixed set of types that say little about this repository, and it ties the commit log to changelog generation. Describe the Scoped Commits convention (https://scopedcommits.com/) instead: the subject names the subsystem a commit touches, and the changelog is written for users rather than derived from the git log.
The changelog step used requarks/changelog-action, which parses Conventional Commits. Under the scoped commits convention every commit is an "invalid commit" to it, so excludeTypes filtered nothing and the output degenerated into a flat list of subjects. Let GitHub generate the change list from the merged pull requests of the release instead, keeping the changelog independent of the git log. Also replace the remaining conventional-commit vocabulary in the version bump job.
The release workflow wrote "Release version X" and "Bump development version to X", which carry no scope. They are ordinary commits rather than the reverts and merges that CONTRIBUTING.md exempts, so they should follow the same convention contributors do. Tag annotations and the GitHub release title are left untouched - they are user-facing labels, not commit messages.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
fix changelog creation and update contribution guide for conventional commits
Fixes #79
Type of change
Please delete options that are not relevant.
Checklist: