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

feat: support GitHub automated release notes #1087

Closed
wants to merge 1 commit into from

Conversation

bcoe
Copy link
Contributor

@bcoe bcoe commented Oct 16, 2021

This will allow you to use release-please for version bumps and CHANGELOG generation, in conjunction with GitHub's new auto-generated release notes.


@ilya-lesikov I had your PR in mind working on this, in a perfect world we'd be able to use GitHub's new .github/release.yml to customize releases, without needing to add templating support to release-please.

Looking at the features in GitHub's auto-generated releases, I don't think it quite matches what you're looking for though?

CC: @MylesBorins

@bcoe bcoe requested review from chingor13 and a team October 16, 2021 00:51
@bcoe bcoe requested a review from a team as a code owner October 16, 2021 00:51
@google-cla google-cla bot added the cla: yes This human has signed the Contributor License Agreement. label Oct 16, 2021
@MylesBorins
Copy link

If you manually call the generate release notes API, rather than passing "generate_release_notes: true" to the create release API you would be able to append a header and footer prior to publishing

@ilya-lesikov
Copy link
Contributor

@bcoe Hi, yes, that's better than nothing but still doesn't give us a way to add custom text before/after, and this is what we needed.

Looking at the template they implemented for Releases I think the best place for this custom text would be their new Release template itself. Here I asked for this to be implemented: community/community#6417

@ilya-lesikov
Copy link
Contributor

Got an update from GitHub, seems they won't be implementing this for now: community/community#6417 (comment)

@bcoe bcoe added the do not merge Indicates a pull request not ready for merge, due to either quality or timing. label Oct 27, 2021
@bcoe
Copy link
Contributor Author

bcoe commented Oct 27, 2021

sitting on this feature for a bit until @chingor13 finishes refactor.

@bcoe bcoe closed this Nov 23, 2021
@chingor13
Copy link
Contributor

Note: this is included in #1120

Copy link

@rdotterer09 rdotterer09 left a comment

Choose a reason for hiding this comment

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

change ok

@chingor13 chingor13 deleted the github-automated-releases branch April 12, 2022 15:46
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
cla: yes This human has signed the Contributor License Agreement. do not merge Indicates a pull request not ready for merge, due to either quality or timing.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants