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.

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

Create changelog from merge commits #3642

Merged
merged 4 commits into from
Jun 23, 2021
Merged

Conversation

feelepxyz
Copy link
Contributor

@feelepxyz feelepxyz commented May 5, 2021

Build the changelog entries from merge commit PR details instead of the individual commits, automating attribution to non-team members and including a link to the PR.

Example:

## v0.146.0, 5 May 2021

- fix(Go mod): detect when remote end hangs up [#3469](https://github.com/dependabot/dependabot-core/pull/3469)
- Final pass on bundler1 test cruft [#3466](https://github.com/dependabot/dependabot-core/pull/3466)
- Handle repo not found errors for go modules [#3456](https://github.com/dependabot/dependabot-core/pull/3456)
- Disabled poetry experimental new installer (@honnix) [#3459](https://github.com/dependabot/dependabot-core/pull/3459)
- Implement delete/create action in GitLab Client (@jerbob92) [#3414](https://github.com/dependabot/dependabot-core/pull/3414)

@thepwagner
Copy link
Contributor

wanted to get feedback on the idea of using gh to do this,

👍

This (PR titles) is what I tend to do manually when I'm not familiar enough with a diff to summarize.

Aside: https://github.com/atlassian/changesets / https://github.com/changesets/action provides some neat tooling here too, but that's a much bigger leap than "CHANGELOG.md, but easier". :shipit:


Alternatively, what about a process that encourages CHANGELOG.md be modified as part of each PR? That solves the summarization problem, and lets contributors decide themselves if they want a shoutout, etc...

Meh, that's manual and tedious - this is ✨magic✨ .

@feelepxyz
Copy link
Contributor Author

Aside: https://github.com/atlassian/changesets / https://github.com/changesets/action provides some neat tooling here too, but that's a much bigger leap than "CHANGELOG.md, but easier". :shipit:

This looks cool! Up for testing it out.

Yeah keen to improve the current flow a bit as I frequently reach for the PRs to reach for author/title.

@feelepxyz feelepxyz marked this pull request as ready for review June 22, 2021 09:49
@feelepxyz feelepxyz requested a review from a team as a code owner June 22, 2021 09:49
@feelepxyz feelepxyz force-pushed the feelepxyz/test-bump-version branch from b81d6ba to dfd9539 Compare June 22, 2021 09:49
Copy link
Member

@jurre jurre left a comment

Choose a reason for hiding this comment

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

I dig it!

bin/bump-version.rb Show resolved Hide resolved
@brrygrdn
Copy link
Contributor

👍🏻 I like this approach, as _thepwagner notes this is automating what I already do when I don't have context on the change. I think it's a good forcing function to encourage expressive Pull Request naming by authors and their reviewers over time.

@@ -7,6 +7,19 @@
end
component = ARGV[0].to_sym

unless `which gh` && $?.success?
puts "Please install the gh cli: brew install gh"
exut 1
Copy link
Member

@Nishnha Nishnha Jun 22, 2021

Choose a reason for hiding this comment

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

nit typo for exit

Copy link
Contributor Author

Choose a reason for hiding this comment

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

nice catch!

bin/bump-version.rb Outdated Show resolved Hide resolved
@feelepxyz feelepxyz merged commit 06a4788 into main Jun 23, 2021
@feelepxyz feelepxyz deleted the feelepxyz/test-bump-version branch June 23, 2021 16:57
@feelepxyz feelepxyz mentioned this pull request Jun 23, 2021
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.

None yet

5 participants