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

jamszh · 2023-04-30T04:48:00Z

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

You can provide a path to a custom commit-partial.hbs file like this one.

./build/src/bin/release-please.js release-pr --token $GITHUB_TOKEN --repo-url jamszh/test-release-please --target-branch main --commit-partial-path .release-please-commit-partial.hbs

Here is an example auto-release PR generated by the command above.

…- address feedback

docs/manifest-releaser.md

jamszh · 2023-06-23T08:49:43Z

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';


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

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

JohnCampionJr · 2023-07-08T15:49:25Z

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

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 · 2023-09-12T12:42:50Z

src/factory.ts

  const changelogNotes = buildChangelogNotes({
    type: options.changelogType || 'default',
    github: options.github,
    changelogSections: options.changelogSections,
+    commitPartial,


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 · 2023-09-12T12:43:20Z

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 · 2023-09-12T12:48:14Z

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 · 2024-05-18T11:19:51Z

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!

jamszh · 2024-08-08T12:06:30Z

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!

I have updated the PR again. It should be ready for another review from @chingor13.
I'm thinking instead of an exclusion list, it might more sensible to add further customisation capabilities to this .hbs file.
Perhaps there is a way to list the authors at the PR level, rather than the commit level.

chingor13

This looks so close. I think we will want to pass the template string in the config, rather than making an extra GitHub API request to fetch the template from a file on the repository. The template contents should be small enough (generally a one-liner)

jamszh · 2024-09-17T06:03:20Z

This looks so close. I think we will want to pass the template string in the config, rather than making an extra GitHub API request to fetch the template from a file on the repository. The template contents should be small enough (generally a one-liner)

The example template I used is quite big.
https://github.com/jamszh/test-release-please/blob/main/.release-please-commit-partial.hbs

Though i'm not too sure how others will use it

Are you saying we should have the contents of the 'commit-partial.hbs' file as part of the config?
It doesn't feel like a one-liner to me, especially if users want something more customized (hence more complicated).

chachako and others added 6 commits April 30, 2023 12:26

feat: add authors and prs api

a6d74c2

test: update test fixtures

498a3e7

feat: Add authors and PR ref when generating default changelog notes …

c6999af

…- address feedback

test: Remove unneeded snapshot changes

c281a43

test: Add new tests for building default-changelog-notes

5b3b3e8

test: add snapshots for newly added tests

cc2dd11

jamszh requested review from a team as code owners April 30, 2023 04:48

product-auto-label bot added the size: xl Pull request size is extra large. label Apr 30, 2023

blunderbuss-gcf bot assigned chingor13 Apr 30, 2023

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 and others added 6 commits April 30, 2023 14:56

fix: lint fix

a11b869

Merge branch 'main' into author-commit-changelog

1b58332

Merge branch 'main' into author-commit-changelog

bc29997

fix(test): add missing attribute to manifest test

29aeb1e

feat: add commit-partial to manifest interface

a496f60

test: add manifest commit-partial

c5e3805

jamszh commented Jun 23, 2023

View reviewed changes

docs/manifest-releaser.md Outdated Show resolved Hide resolved

jamszh commented Jun 23, 2023

View reviewed changes

jamszh mentioned this pull request Jul 1, 2023

GitHub extend jamszh/release-please#1

Closed

4 tasks

jamszh added 3 commits July 2, 2023 11:54

fix: provide path to commit partial .hbs file

f6d5c14

fix: lint fix

690cba0

docs: update docs to use path

d237977

chingor13 requested changes Sep 5, 2023

View reviewed changes

jamszh commented Sep 12, 2023

View reviewed changes

jamszh requested a review from chingor13 September 12, 2023 12:53

jamszh added 2 commits August 8, 2024 21:06

Merge branch 'main' into author-commit-changelog

31130ee

fix: add command option to cli yarg

4da4d5b

chingor13 added 2 commits September 11, 2024 14:12

Merge branch 'main' into author-commit-changelog

2f838ad

fix test

b7b40b1

chingor13 requested changes Sep 11, 2024

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

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

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

jamszh commented Apr 30, 2023 •

edited

Loading

jamszh Jun 23, 2023 •

edited

Loading

JohnCampionJr commented Jul 8, 2023 •

edited

Loading

chingor13 left a comment

jamszh Sep 12, 2023 •

edited

Loading

jamszh commented Sep 12, 2023

jamszh commented Sep 12, 2023 •

edited

Loading

jxn-30 commented May 18, 2024

jamszh commented Aug 8, 2024 •

edited

Loading

chingor13 left a comment

jamszh commented Sep 17, 2024

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

Are you sure you want to change the base?

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

Conversation

jamszh commented Apr 30, 2023 • edited Loading

Context:

Changes:

TESTING

jamszh Jun 23, 2023 • edited Loading

Choose a reason for hiding this comment

JohnCampionJr commented Jul 8, 2023 • edited Loading

chingor13 left a comment

Choose a reason for hiding this comment

jamszh Sep 12, 2023 • edited Loading

Choose a reason for hiding this comment

jamszh commented Sep 12, 2023

jamszh commented Sep 12, 2023 • edited Loading

jxn-30 commented May 18, 2024

jamszh commented Aug 8, 2024 • edited Loading

chingor13 left a comment

Choose a reason for hiding this comment

jamszh commented Sep 17, 2024

jamszh commented Apr 30, 2023 •

edited

Loading

jamszh Jun 23, 2023 •

edited

Loading

JohnCampionJr commented Jul 8, 2023 •

edited

Loading

jamszh Sep 12, 2023 •

edited

Loading

jamszh commented Sep 12, 2023 •

edited

Loading

jamszh commented Aug 8, 2024 •

edited

Loading