UC-Davis-molecular-computing / scadnano-python-package

Python scripting library for generating designs readable by scadnano.
https://scadnano.org
MIT License
13 stars 7 forks source link

switch to better GitHub action for generating release notes #196

Open dave-doty opened 2 years ago

dave-doty commented 2 years ago

See also https://github.com/UC-Davis-molecular-computing/scadnano/issues/622.

This tool looks better than what we are using now, for instance: https://github.com/github-tools/github-release-notes

For one, it uses the commit description, not only the message/title. It also can pull information from issues, it seems, not only commit messages.

Also it would be good if it also appended the information to a CHANGELOG file, so that we have an official non-GitHub record of the changes. Right now they are all in GitHub release notes, but it would be good to have a Markdown file called CHANGELOG with all the release notes as well. That way, if for some reason the GitHub servers were wiped clean, the CHANGELOG file would still be a record of what had been done that is stored in our local repos.