Add `--generate-notes` flag to `gh release create` command. by Sixeight · Pull Request #4467 · cli/cli

Sixeight · 2021-10-09T08:43:51Z

TODO

We should not offer both Automatically generate the release notes and Write using commit log as template. These options are too similar (they both use git log to generate release notes) and we should prefer to use the new API and retire the old approach.
We should allow the editor phase for when you choose Automatically generate the release notes so you can review the release notes before posting. This API endpoint can be used for fetching generated release notes before a release is actually created.
If the API isn't available (e.g. in a GitHub Enterprise version), generating release notes should fall back to the current implementation of using the git commit log locally.
The non-interactive flag --generate-notes allows you to skip the editor phase. This would have the same behavior that you currently implemented, except that we propose that the flag name is shorter than --generate-release-notes.

mislav

Hi, this looks like a great start! Thank you for your contribution.

Before this ships, I think there are a number of changes I would like to propose here in order to improve the overall experience of creating releases with generated notes. However, because these suggestions increase the complexity of the changeset that would be required to implement them, I'm not necessarily asking you to do it in this PR. One of our team could use your PR as a starting point and bring this to completion.

Here are my thoughts:

We should not offer both Automatically generate the release notes and Write using commit log as template. These options are too similar (they both use git log to generate release notes) and we should prefer to use the new API and retire the old approach.
We should allow the editor phase for when you choose Automatically generate the release notes so you can review the release notes before posting. This API endpoint can be used for fetching generated release notes before a release is actually created.
If the API isn't available (e.g. in a GitHub Enterprise version), generating release notes should fall back to the current implementation of using the git commit log locally.
The non-interactive flag --generate-notes allows you to skip the editor phase. This would have the same behavior that you currently implemented, except that we propose that the flag name is shorter than --generate-release-notes.

How does all that sound? @Sixeight: you may continue working on this PR if you feel up for it, and otherwise we can take this over at this point. Again, thank you for making this!

Sixeight · 2021-10-17T08:28:10Z

@mislav Thank you for your polite reply.
I understand what you want to do with new release note generation API.
So, I will try to implement the idea.
(If my implementation speed does not meet your expectations, please do not hesitate to let me know.)

pkg/cmd/release/create/create.go

Sixeight · 2021-10-17T10:28:27Z

@mislav @samcoe All done. Please review at your leisure.

samcoe

@Sixeight This is looking great so far. Really nice work, thanks for addressing @mislav's comments. I left just a couple comments and questions for discussion before this is ready to merge, but we are close I think.

pkg/cmd/release/create/create.go

pkg/cmd/release/create/create_test.go

Sixeight · 2021-11-03T14:53:10Z

I'm sorry, I haven't gotten around to it and it's taking me a while to implement.

sandstrom · 2021-11-30T12:10:31Z

@mislav or @samcoe is this something you (Github) is planning to add support for? It would be a great addition!

If it is, maybe you could pick this PR up and drive it over the finish line?

It seems like this contributor has gotten pretty far, but relying on volunteers working on their spare time is bound to be slow :) Maybe better if someone employed by Github could drive it to completion.

samcoe

@Sixeight Thanks for the contribution! I went ahead and rebased against trunk as well as made a couple commits that added a bit of 💅 and created an interactive test. The interactive test turned out to be fairly involved to write, involving a small refactor, so great work on getting us that far!

mislav

@samcoe This looks and works great! Thanks for working on this 🌟

pkg/cmd/release/create/create.go

pkg/surveyext/editor_manual.go

pkg/cmd/release/create/create.go

mislav

Looks good, but just note the HTTP status check

pkg/cmd/release/create/http.go

mislav

Looks good, but just note the HTTP status check

pkg/cmd/release/create/http.go

Sixeight changed the title ~~Add --generate-release-notes flag to gh release create command.~~ Add --generate-release-notes flag to gh release create command. Oct 9, 2021

mislav reviewed Oct 13, 2021

View reviewed changes

samcoe self-assigned this Oct 13, 2021

Sixeight requested a review from a team as a code owner October 17, 2021 08:35

Sixeight requested review from mislav and removed request for a team October 17, 2021 08:35

Sixeight changed the title ~~Add --generate-release-notes flag to gh release create command.~~ Add --generate-notes flag to gh release create command. Oct 17, 2021

Sixeight force-pushed the add-generate-release-notes-flag-to-release-create branch from 09d9c48 to 6e9441f Compare October 17, 2021 10:24

Sixeight commented Oct 17, 2021

View reviewed changes

pkg/cmd/release/create/create.go Show resolved Hide resolved

samcoe suggested changes Oct 19, 2021

View reviewed changes

samcoe added the hacktoberfest-accepted label Oct 27, 2021

Sixeight and others added 8 commits December 7, 2021 20:11

Add --generate-release-notes flag to gh release create command.

2e874c8

Use --generate-notes instead of --generate-release-notes

d07791d

Add write using generate releaes notes as tempalte options

019e124

Use commit log as release notes for GH Enterprise

9340406

Ignore blank name/body params for release

9b376e9

Add some test of generate_notes option for gh release create

dfffdb0

Update surveyext.Edit signature to make it easier to stub in tests

258162e

Small polish and interactive test

2d6b1c2

samcoe force-pushed the add-generate-release-notes-flag-to-release-create branch from 6e9441f to 2d6b1c2 Compare December 7, 2021 16:11

Fix whitespace

6607e7c

samcoe approved these changes Dec 7, 2021

View reviewed changes

mislav suggested changes Dec 7, 2021

View reviewed changes

Address PR comments

06ab226

samcoe requested a review from mislav December 8, 2021 07:02

mislav approved these changes Dec 8, 2021

View reviewed changes

pkg/cmd/release/create/http.go Outdated Show resolved Hide resolved

mislav approved these changes Dec 8, 2021

View reviewed changes

pkg/cmd/release/create/http.go Outdated Show resolved Hide resolved

401 to 404

6504762

samcoe merged commit a9d397b into cli:trunk Dec 8, 2021

MaxHorstmann mentioned this pull request Jan 9, 2022

Automatically create a matching release for every NuGet version kubernetes-client/csharp#759

Merged

spenserblack mentioned this pull request Jan 12, 2022

gh release create: "Write using git tag message as template" option is hidden sometimes even when annotations exist #5027

Closed

Sixeight deleted the add-generate-release-notes-flag-to-release-create branch March 31, 2022 10:00

Conversation

Sixeight commented Oct 9, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

TODO

Uh oh!

mislav left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Sixeight commented Oct 17, 2021

Uh oh!

Uh oh!

Sixeight commented Oct 17, 2021

Uh oh!

samcoe left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Sixeight commented Nov 3, 2021

Uh oh!

sandstrom commented Nov 30, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

samcoe left a comment

Choose a reason for hiding this comment

Uh oh!

mislav left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

mislav left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

mislav left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

Sixeight commented Oct 9, 2021 •

edited

Loading

mislav left a comment •

edited

Loading

sandstrom commented Nov 30, 2021 •

edited

Loading