feat: add include-commit-authors option to include author info in changelogs #2628
+168
−2
Conversation
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
…ngelogs This adds a new configuration option `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 Changes: - Add `CommitAuthor` interface to capture author metadata - Update GraphQL query to fetch author info (name, email, username) - Add `includeCommitAuthors` to ReleaserConfig and BuildNotesOptions - Update DefaultChangelogNotes to render author info when enabled - Add documentation for CLI and manifest config - Add tests for the new functionality Fixes googleapis/release-please-action#1063 Fixes googleapis#1716
mldangelo
force-pushed
the
feat/include-commit-authors
branch
from
9b61084 to
2d3d4a6
Compare
|
Would love to see this go in! Could someone give this a review please? |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 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 configuration option
include-commit-authorsthat appends commit author information to changelog entries.Example output:
Changes
CommitAuthorinterface to capture author metadata (name, email, username)includeCommitAuthorstoReleaserConfigandBuildNotesOptionsDefaultChangelogNotesto render author info when enabledBehavior
When enabled:
(@username)if GitHub username is availableConfiguration
CLI:
In
release-please-config.json:{ "include-commit-authors": true }Fixes #1716
Fixes googleapis/release-please-action#1063 🦕
Thanks for maintaining this project! Happy to make any changes needed.