algorand / go-algorand

Algorand's official implementation in Go.
https://developer.algorand.org/
Other
1.35k stars 470 forks source link

Script to generate go-algorand release notes #3520

Closed yaovi-a closed 2 years ago

yaovi-a commented 2 years ago

Context

In an effort to generate release notes we need a script that can pull the PR titles along with the PR label and generate the release notes.

Objective 

Generation of go-algorand release notes

Value Add 

Reduce toil when generating release toils Shorten time to release once all PRs are merged

Design notes 

  1. Create a script that can pull the PR title and then use GitHub actions to pull the labels
  2. Generate release notes

https://docs.google.com/document/d/1NAOMA1LIMuLjqEAlZNDmuHBkq3MiL1l2YcfwFy_ZdQs/edit#heading=h.ncu9dcl0rwba

Success criteria

Automated release notes that are published to go-algorand github repo

egieseke commented 2 years ago

For this to work correctly, we will need to socialize the formating of the PR titles and the use of labels for the type. The PR titles should be formatted like: Category: Description-text

Note that this format follows the new format required by this issue.

GitHub Logo

Highlights

Protocol Upgrade

This release contains a protocol upgrade.

Changelog

Enhancement

Additional Resources