Skip to content

feat: add include-commit-authors input to include author info in changelogs#1166

Open
mldangelo wants to merge 1 commit intogoogleapis:mainfrom
mldangelo:feat/include-commit-authors
Open

feat: add include-commit-authors input to include author info in changelogs#1166
mldangelo wants to merge 1 commit intogoogleapis:mainfrom
mldangelo:feat/include-commit-authors

Conversation

@mldangelo
Copy link
Copy Markdown

@mldangelo mldangelo commented Nov 28, 2025

Adds a new action input include-commit-authors that appends commit author information to changelog entries.

Example output:

feat(vehicle)!: the_commit_message (#123) (@username)

Depends on

This PR depends on googleapis/release-please#2628. The as any type assertions here will be cleaned up once that's merged and a new release-please version is published.

Changes

  • Added include-commit-authors input to action.yml
  • Updated src/index.ts to pass the option through to Manifest.fromConfig()
  • Added override for manifest-based configs (similar to changelogHost)

Usage

- uses: google-github-actions/release-please-action@v4
  with:
    include-commit-authors: true

Or in release-please-config.json:

{
  "include-commit-authors": true
}

Tests

  • Added tests for release-type config
  • Added tests for manifest config override
  • All existing tests pass

Thanks for your work on this project! Fixes #1063. Let me know if you'd like any changes.

@ferrarimarco
Copy link
Copy Markdown
Contributor

Thanks for this PR. Need to have a look at googleapis/release-please#2628 first, I guess. :)

@1zha0
Copy link
Copy Markdown

1zha0 commented Apr 14, 2026

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
@mldangelo
Copy link
Copy Markdown
Author

Thanks for rebasing, @ferrarimarco! And thanks to @1zha0 for the nudge.

The upstream feature landed in release-please 17.5.0, so the as any casts can be cleaned up once #1199 bumps the dependency. Happy to push that cleanup after it merges, or fold it into this PR if you'd prefer — whatever's easiest.

For context, the config JSON option ("include-commit-authors": true in release-please-config.json) will work as soon as #1199 lands. This PR adds the action input so users who configure everything in their workflow YAML (without a manifest config) can use it too.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Is there a way to configure release-please to add a commit author in changelog lines?

3 participants