Skip to content

Support generating release notes#2

Merged
caithagoras merged 5 commits intoprestodb:masterfrom
caithagoras:s1
Feb 18, 2020
Merged

Support generating release notes#2
caithagoras merged 5 commits intoprestodb:masterfrom
caithagoras:s1

Conversation

@caithagoras
Copy link

@caithagoras caithagoras commented Feb 14, 2020

The PR introduces a tool which formalize the release notes collection in the release process.

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

  1. Switch to master branch. Fast-forward to upstream master.
  2. Use git log to find the commits introduced in the new release.
  3. Use Github GraphQL API v4 to fetch the PRs associated with the commits.
  4. Parse the PR description, generate release notes, create release branch, modify local files, create release notes commit, and push to origin.
  5. 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=LATEST&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>

@caithagoras
Copy link
Author

Supersedes prestodb/presto#13964

@caithagoras
Copy link
Author

@aweisberg Addressed all comments in prestodb/presto#13964

Copy link

@mayankgarg1990 mayankgarg1990 left a comment

Choose a reason for hiding this comment

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

LGTM

@caithagoras
Copy link
Author

  • Move .travis.yml to the first commit
  • Made a few fixes, will squash before merging

@caithagoras caithagoras added the squash-commits Some commits needs to be squashed before merging label Feb 18, 2020
@caithagoras caithagoras force-pushed the s1 branch 2 times, most recently from b59a209 to d5c5f79 Compare February 18, 2020 06:41
Also, update to maven-shade-plugin 3.2.1 and
really-executable-jar-maven-plugin 1.5.0.
@caithagoras caithagoras deleted the s1 branch February 18, 2020 20:21
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

squash-commits Some commits needs to be squashed before merging

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants