(Discussion) Use 'conventionalcommits' preset instead of 'angular' to support custom changelog sections
See original GitHub issueHi Mathieu,
I’m working on a fix for https://github.com/mathieudutour/github-tag-action/issues/54. I’ve mentioned why this is closed but not fixed in this comment.
So, before creating a PR for this, I just wanted to get your feedback beforehand on the approach that I’m taking.
Here’s what I’m doing to fix this:
- Currently, the default preset used to
generateNotes
is conventional-changelog-angular which doesn’t support custom changelog sections but conventionalcommits does. (Reference: https://github.com/semantic-release/release-notes-generator/issues/153). I’m more inclined to using the preset instead of copying & pasting thetransform
function and modifying it to fit the use case.
-
Right now,
custom_release_rules
supports<keyword>:<release_type>
. I’m thinking of adding another section to this that mentions the changelog section/title the commits in this group should persist in. i.e.<keyword>:<release_type>:<changelog_section>
Any support for gitmoji in the changelog section/title will already be supported after https://github.com/mathieudutour/github-tag-action/issues/67 is fixed. -
This last/new section will be optional whose default value will be what’s used on
conventional-changelog-angular
. Any rules the user provides will override the rule, if it exists in the default rule else gets added with the default rule.
You can find my latest changes for this here
Let me know what you think
Issue Analytics
- State:
- Created 3 years ago
- Reactions:2
- Comments:6 (3 by maintainers)
That makes sense to me 👍
We can discuss the implementation details in the PR
@koiralakiran1 Sorry I missed that part, where I needed to include the changelog section, again thank you very much for your work!