Auto-Generate Release Notes (of Future Releases) - Githubissues

fossasia / visdom

A flexible tool for creating, organizing, and sharing visualizations of live, rich data. Supports Torch and Numpy.

Apache License 2.0

9.93k stars 1.13k forks source link

Auto-Generate Release Notes (of Future Releases) #906

Closed da-h closed 1 year ago

da-h commented 1 year ago

Description

As of now, this project uses GitHub's own action for creating new releases named action/create-release. However, the action is currently unmaintained, and the developers suggest using an alternative in their README.md.

This PR also

enables automatically generated release notes containing a list of PRs added with the new release. (Currently, auto-generation of release notes can be only done manually: editing a specific release reveals the button "Generate release notes").
Adapts the release naming:
- previously: Release 0.2.4
- new naming: Visdom v0.2.4
  (to match the tag name. any other suggestions?)

How Has This Been Tested?

Tested the change successfully in a personal project of mine. As an example release using this method I've attached a screenshot below:

Checklist:

[ ] I adapted the version number under py/visdom/VERSION according to Semantic Versioning
[ ] My code follows the code style of this project.
[ ] My change requires a change to the documentation.
[ ] I have updated the documentation accordingly.