Support Release Notes Generation by caithagoras · Pull Request #13964 · prestodb/presto

caithagoras · 2020-01-14T20:41:10Z

The PR introduces a tool which formalize the release notes collection in the release process.
Address part of #13970.

Release Notes Collection

To streamline the release process, we introduced a requirement (and PR template) to ask authors to write release notes in the PR description. During the release process, the person doing the release will be able to use this tool to collect and generate the release commit and PR, before polishing it as according to the
Release Notes Guideline.

What does the tool do

Switch to master branch. Fast-forward to upstream master.
Use git log to find the commits introduced in the new release.
Use Github GraphQL API v4 to fetch the PRs associated with the commits.
Parse the PR description, generate release notes, create release branch, modify local files, create release notes commit, and push to origin.
Create a release notes PR, with description populated. Release notes PR description contains 3 sections:
a. A list of PRs with missing release notes, either the PR description do not contain release notes, or the release notes were malformed.
b. A list of extracted release notes.
c. A list of all commits introduced in the release.

How to use the tool

To collect release notes, run the following command after cutting the release branch (bumping the snapshot version on the master branch):

curl -L -o /tmp/presto_release "https://oss.sonatype.org/service/local/artifact/maven/redirect?g=com.facebook.presto&a=presto-release&v=0.232-20200123.012813-4&r=snapshots&c=executable&e=jar"
chmod 755 /tmp/presto_release
/tmp/presto_release release-notes --github-user <GITHUB_USER> --github-access-token <GITHUB_ACCESS_TOKEN>

The changes have been tested end-to-end. Idea for unit testing are welcomed.

== RELEASE NOTES ==
Release Tool Changes
* Add a tool to collect and generate release notes (:pr:`13964`).

caithagoras · 2020-01-15T23:10:45Z

@aweisberg Since @mayankgarg1990 is on PTO, could you help reviewing this PR? Thank you!

aweisberg

Wow, this is great, but also huge. GenerateReleaseNotesTask has a lot of behavior in it. It tested it and found a few things. I think I will want to do another pass on GenerateReleaseNotesTask.

Why an empty presto-release/README.txt?

Ultimately the documentation for this should live somewhere that isn't the PR description.

If you restart the process partway through it fails the 2nd time creating the branch. If you try to repeat the process it also fails. I assume this will be common because people fix the missing/broken release notes in their PRs and then you rerun this.

presto-release/src/main/java/com/facebook/presto/release/AbstractAnnotatedProvider.java

presto-release/src/main/java/com/facebook/presto/release/ForPresto.java

presto-release/src/main/java/com/facebook/presto/release/git/ForGithub.java

aweisberg · 2020-01-17T18:46:34Z

presto-release/src/main/java/com/facebook/presto/release/git/GitActor.java

A little weird that it's a GitActor, but it's not a subclass of Actor. It makes them seem like they have something in common when apparently they don't.

This is how objects are defined in Github API:
Actor (Interface): https://developer.github.com/v4/interface/actor/
GitActor (Object): https://developer.github.com/v4/object/gitactor/

My understanding is that the "Git" in "GitActor" refers to git, the version control system, while Actor is more of a short form for GithubActor.

presto-release/src/main/java/com/facebook/presto/release/git/Actor.java

presto-release/src/main/java/com/facebook/presto/release/git/GitCommandsBinder.java

presto-release/src/main/java/com/facebook/presto/release/git/PullRequest.java

presto-release/src/main/java/com/facebook/presto/release/tasks/GenerateReleaseNotesCommand.java

aweisberg · 2020-01-17T19:42:45Z

presto-release/src/main/java/com/facebook/presto/release/tasks/GenerateReleaseNotesTask.java

It looks like some of this PR entry didn't get preserved #13604 All the lines starting with + got turned into a run-on sentence.

Not sure what this comment means?

If you run this tool it generates

and

From that PR.

This is the expected behavior since we never said we would support sub-bullet-point.
If the release notes section cannot be properly parsed, the PR will shown in the missing release notes section.

tdcmeehan · 2020-01-29T04:02:52Z

I came across this PR. I just skimmed and have a couple of high-level questions.

Does this need to exist inside the main PrestoDB repo? Can it exist in a stand-alone repository? The Presto build is already long and the codebase already vast, it would be better to put this somewhere independent if there's no code sharing.
The lines of code are quite hefty and we'll need to maintain this is as part of the mainline Presto build. Could it have been written more concisely with some 3rd party libraries, or even with a different language like Python?

aweisberg

This looks great. I had two minor things to tweak and there was the one case where it maybe doesn't handle the inputs the way we want.

aweisberg · 2020-01-23T17:05:23Z

presto-release/NOTICE

Nit, I think most projects put the NOTICE file in a top level directory so it's human findable without much effort
https://github.com/docker/engine
https://github.com/apache/hadoop

How did we assemble the list of NOTICES we need to include?

I'm moving NOTICE and README.md to the top level. They're specified in src/main/assembly/presto-release-tools.xml

aweisberg · 2020-01-23T17:53:55Z

presto-release/README.md

Is what you are supposed to fetch going to change over time when the binary is updated? Is there a better way to do this?

Updated. We can do v=LATEST to fetch the latest snapshot version. When there is a release of this project, we can change it to point to the latest release version.

presto-release/README.md

presto-release/src/main/java/com/facebook/presto/release/git/GitBinder.java

aweisberg · 2020-01-29T16:46:20Z

presto-release/src/main/java/com/facebook/presto/release/tasks/GenerateReleaseNotesTask.java

If you run this tool it generates

and

From that PR.

Will merge into 1st commit

caithagoras · 2020-02-17T21:25:13Z

Superseded by prestodb/presto-release-tools#2

caithagoras added the wip Work In Progress label Jan 14, 2020

caithagoras force-pushed the r1 branch 16 times, most recently from 1810871 to def7ec1 Compare January 15, 2020 22:34

caithagoras changed the title ~~[WIP] Support Release Notes Generation~~ Support Release Notes Generation Jan 15, 2020

caithagoras requested review from aweisberg and mayankgarg1990 January 15, 2020 22:38

caithagoras assigned aweisberg and mayankgarg1990 Jan 15, 2020

caithagoras removed the wip Work In Progress label Jan 15, 2020

caithagoras force-pushed the r1 branch from def7ec1 to 2eb109f Compare January 16, 2020 03:18

aweisberg suggested changes Jan 17, 2020

View reviewed changes

caithagoras force-pushed the r1 branch 4 times, most recently from 43fb4f9 to d2345d7 Compare January 17, 2020 23:56

caithagoras force-pushed the r1 branch 2 times, most recently from 0c6e57b to 07dc820 Compare January 27, 2020 22:42

caithagoras added the squash-before-merge label Jan 27, 2020

caithagoras force-pushed the r1 branch 14 times, most recently from 24e406b to c6582b4 Compare January 29, 2020 00:33

caithagoras mentioned this pull request Jan 29, 2020

[WIP] Support Cutting Release #14023

Closed

aweisberg approved these changes Jan 29, 2020

View reviewed changes

caithagoras force-pushed the r1 branch from c6582b4 to 08054ed Compare February 14, 2020 02:19

caithagoras0 added 4 commits February 13, 2020 18:20

Add utilities to run git commands

f31ddde

Will merge into 1st commit

Support fetching and creating pull requests

4f4dcad

Support generating release notes

225e282

Publish executable jar and tarball for presto-release

3a35678

caithagoras force-pushed the r1 branch from 08054ed to 3a35678 Compare February 14, 2020 02:21

caithagoras mentioned this pull request Feb 14, 2020

Support generating release notes prestodb/presto-release-tools#2

Merged

caithagoras closed this Feb 17, 2020

caithagoras deleted the r1 branch February 17, 2020 21:25

Conversation

caithagoras commented Jan 14, 2020 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Release Notes Collection

What does the tool do

How to use the tool

Uh oh!

caithagoras commented Jan 15, 2020

Uh oh!

aweisberg left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

caithagoras Feb 14, 2020 • 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!

tdcmeehan commented Jan 29, 2020

Uh oh!

aweisberg left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

caithagoras Feb 14, 2020 • 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!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

caithagoras commented Feb 17, 2020

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

caithagoras commented Jan 14, 2020 •

edited

Loading

caithagoras Feb 14, 2020 •

edited

Loading

caithagoras Feb 14, 2020 •

edited

Loading