search

Project-MONAI / MONAI

AI Toolkit for Healthcare Imaging
https://monai.io/
Apache License 2.0
5.71k stars 1.04k forks source link

Structured changelog and sync with GitHub release notes #229

Closed tvercaut closed 8 months ago

tvercaut commented 4 years ago

As a follow-up of #197, MONAI should provide structured changelogs.

A good practice for this (see e.g. NiftyNet), is to follow the keep a changelog recomendations.

A tool such as release-drafter or chandler can then be use to automate syncing information between the change log file and the GitHub release notes.

NiftyNet used chandler for this but chandler is no longer actively maintained and recomend to switch to release-drafter: https://github.com/NifTK/NiftyNet/blob/dev/CONTRIBUTING.md#making-a-release https://github.com/NifTK/NiftyNet/blob/dev/.gitlab-ci.yml

tvercaut commented 4 years ago

For the record, there is also a tool called gren : https://github.com/github-tools/github-release-notes

gren also allows the automated creation of a CHANGELOG.md file from the release notes which apparently is not the case for release-drafter.

wyli commented 2 years ago

Github is providing some features for this https://docs.github.com/en/repositories/releasing-projects-on-github/automatically-generated-release-notes

vikashg commented 8 months ago

closing because of inactivity