Automates release note generation - Githubissues

hypertrace / hypertrace-service

Multiple hypertrace services combined together to form a single service.

Other

4 stars 15 forks source link

Automates release note generation #62

Closed JBAhire closed 3 years ago

JBAhire commented 3 years ago

Description

Addresses https://github.com/hypertrace/hypertrace/issues/156
Adds Gren bot (https://github.com/github-tools/github-release-notes#feed-gren-) to get create automatic release notes.
Added this as a part of publish workflow in GitHub actions so it will automatically run every time we publish new release.
Added .grenrc.js which formats the output of GREN bot according to our requirements.

Testing

These are updated release notes for latest release in this repo generated by Gren bot

Screenshot 2021-01-21 at 12 04 39 PM

Ref PR: https://github.com/hypertrace/pinot/pull/61

Checklist:

[x] My changes generate no new warnings
[x] I have added tests that prove my fix is effective or that my feature works
[x] Any dependent changes have been merged and published in downstream modules

Documentation

This utility uses labels for grouping PRs into categories so please use appropriate labels in upcoming PRs.

In order to have splendidly generated release notes, we recommend to follow these conventions:

Start the subject line with a verb (e.g. Change header styles)
Use the imperative mood in the subject line (e.g. Fix, not Fixed or Fixes header styles)
Limit the subject line to about 50 characters
Do not end the subject line with a period
Separate subject from body with a blank line
Wrap the body at 72 characters
Use the body to explain what and why not how