feat: add include-commit-authors input to include author info in changelogs#1166
Open
mldangelo wants to merge 2 commits intogoogleapis:mainfrom
Open
feat: add include-commit-authors input to include author info in changelogs#1166mldangelo wants to merge 2 commits intogoogleapis:mainfrom
mldangelo wants to merge 2 commits intogoogleapis:mainfrom
Conversation
…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
Collaborator
|
Thanks for this PR. Need to have a look at googleapis/release-please#2628 first, I guess. :) |
2 tasks
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.
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.