feat(version): provide custom format to include commit author fullname #269
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
Add a new flag
--changelog-include-commit-author-fullname [msg]
to specify if we want to include the git commit author's name, at the end of each changelog commit entry, this is only available when using--conventional-commits
with changelogs. The default format will append the author's name at the end of each commit entry and wrapped in()
, for exampe "feat: commit message (Author Name)". We could also use a custom format by providing the%a
token. Note that in every case, the author's name will always be appended as a suffix to each changelog commit entry.Motivation and Context
This improves the previous implementation done in PR #253, the previous implementation assumed wrongly that the author name was the same as the GitHub username while in fact it's totally different and is instead the name configured in git. This partially addresses issue #248
This PR adds the following flag
--changelog-include-commit-author-fullname [msg]
it was previously implemented as a different flag name
--changelog-include-commit-author
A future PR is expected to add a second flag to add the GitHub username
--changelog-include-commit-author-username [msg]
How Has This Been Tested?
Types of changes
Checklist: