feat: add include-commit-authors input to include author info in changelogs#1166
feat: add include-commit-authors input to include author info in changelogs#1166mldangelo wants to merge 1 commit intogoogleapis:mainfrom
Conversation
|
Thanks for this PR. Need to have a look at googleapis/release-please#2628 first, I guess. :) |
|
Now that, googleapis/release-please#2628 has been merged, can this PR also been reviewed and merged. @chingor13 and @ferrarimarco |
…gelogs This adds a new action input `include-commit-authors` that when enabled, appends commit author information to changelog entries. When the option is enabled: - If the commit has a GitHub username, it displays as `(@username)` - Otherwise, it falls back to the commit author's name Example changelog entry with authors enabled: feat(vehicle)!: the_commit_message (#pr_number) (@username) Note: This PR depends on googleapis/release-please#XXXX being merged first. The `as any` type assertions will be removed once release-please is updated with the new `includeCommitAuthors` config option. Fixes googleapis#1063
3c2dbc6 to
7dbe58f
Compare
|
Thanks for rebasing, @ferrarimarco! And thanks to @1zha0 for the nudge. The upstream feature landed in release-please 17.5.0, so the For context, the config JSON option ( |
Adds a new action input
include-commit-authorsthat appends commit author information to changelog entries.Example output:
Depends on
This PR depends on googleapis/release-please#2628. The
as anytype assertions here will be cleaned up once that's merged and a new release-please version is published.Changes
include-commit-authorsinput toaction.ymlsrc/index.tsto pass the option through toManifest.fromConfig()changelogHost)Usage
Or in
release-please-config.json:{ "include-commit-authors": true }Tests
Thanks for your work on this project! Fixes #1063. Let me know if you'd like any changes.