Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

feat(api): Add the ability to include commit authors and PR references to default-changelog-notes #1938

Open
wants to merge 15 commits into
base: main
Choose a base branch
from
Open

feat(api): Add the ability to include commit authors and PR references to default-changelog-notes #1938

wants to merge 15 commits into from

Conversation

jamszh
Copy link

@jamszh jamszh commented Apr 30, 2023 •
edited

Thank you for opening a Pull Request! Before submitting your PR, there are a few things you can do to make sure it goes smoothly:

  • Make sure to open an issue as a bug/issue before writing your code! That way we can discuss the change, evaluate designs, and agree on the general idea
  • Ensure the tests and linter pass
  • Code coverage does not decrease (if any source code was changed)
  • Appropriate docs were updated (if necessary)

Context:

Fixes #1716 🦕

This PR is a follow-up to #1717
We can probably close it as my PR is based off it.

Changes:

  • Utilise the commitPartial attribute from BaseStrategyOptions
  • Add commitPartialPath to the manifest config and friends
  • Commit authors and PR reference links can be added to the commit entries for a release by providing a custom .release-please-commit-partial.hbs file.
    • You can find the template file here (we default to this template when no commitPartialPath is provided)

TESTING

I have done testing on this dummy repo.
https://github.com/jamszh/test-release-please

Here is an example auto-release PR

@jamszh jamszh requested review from a team as code owners April 30, 2023 04:48
@product-auto-label product-auto-label bot added the size: xl Pull request size is extra large. label Apr 30, 2023
@jamszh jamszh changed the title feat(api): Add the ability to include commit authors and PR references to generated changelogs feat(api): Add the ability to include commit authors and PR references to default-changelog-notes Apr 30, 2023
jamszh
jamszh commented Jun 23, 2023
View reviewed changes
docs/manifest-releaser.md Outdated Show resolved Hide resolved
jamszh
jamszh commented Jun 23, 2023
View reviewed changes
test/changelog-notes/default-changelog-notes.ts
import {PullRequestBody} from '../../src/util/pull-request-body';
import {Version} from '../../src/version';
const presetFactory = require('conventional-changelog-conventionalcommits');

const COMMIT_WITH_AUTHOR_FORMAT = '{{#if authors}} by {{authors}}\n {{~/if}}\n';
Copy link
Author

@jamszh jamszh Jun 23, 2023 •
edited

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Add PR author to a commit entry for the generated release notes.

I wonder if this feature be default or opt-in.

@jamszh jamszh mentioned this pull request Jul 1, 2023
Closed
4 tasks
@JohnCampionJr
Copy link

JohnCampionJr commented Jul 8, 2023 •
edited

This would be very nice to have! Another related thought, maybe a list of excluded authors? For example, I wouldn't want myself listed by every single commit I do.

chingor13
chingor13 requested changes Sep 5, 2023
View reviewed changes
Copy link
Contributor

@chingor13 chingor13 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sorry for the late review, but this is looking great!

One question -- is this opt-in? IMO, all the new features should not change existing behavior.

jamszh
jamszh commented Sep 12, 2023
View reviewed changes
src/factory.ts
const changelogNotes = buildChangelogNotes({
type: options.changelogType || 'default',
github: options.github,
changelogSections: options.changelogSections,
commitPartial,
Copy link
Author

@jamszh jamszh Sep 12, 2023 •
edited

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This feature is entirely opt-in.

commitPartial already existed as as optional argument prior to this PR.
It was just never used.

release-please/src/factories/changelog-notes-factory.ts

Line 27 in cd0bd85

commitPartial?: string;

So now we provide a real value if commitPartialPath (newly added as part of this PR) is specified in the manifest file.

@jamszh
Copy link
Author

jamszh commented Sep 12, 2023

Sorry for the late review, but this is looking great!

One question -- is this opt-in? IMO, all the new features should not change existing behavior.

Yep.
See: https://github.com/googleapis/release-please/pull/1938/files#r1322981745

@jamszh
Copy link
Author

jamszh commented Sep 12, 2023 •
edited

This would be very nice to have! Another related thought, maybe a list of excluded authors? For example, I wouldn't want myself listed by every single commit I do.

Yeah I can see this being annoying.
The exclusion list could work.

I was thinking we could also remove the @ from the author's user ID when building the notes.

Alternatively, I wonder if it is possible to supress the notifications for these Github mentions created by release-please.

@jxn-30
Copy link

jxn-30 commented May 18, 2024

What is the current state of this PR?
Would love to see this, especially in combination with the beforementioned exclude-list!

Thanks for your work!

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

@chingor13 chingor13 Awaiting requested review from chingor13

Requested changes must be addressed to merge this pull request.

Assignees

@chingor13 chingor13

Labels
size: xl Pull request size is extra large.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Add commit fields to access authors and PR number
5 participants
@jamszh @JohnCampionJr @jxn-30 @chingor13 @chachako