Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Structured changelog and sync with GitHub release notes #229

Closed
tvercaut opened this issue Mar 30, 2020 · 3 comments
Closed

Structured changelog and sync with GitHub release notes #229

tvercaut opened this issue Mar 30, 2020 · 3 comments
Labels
CI/CD Low risk nice-to-have features

Comments

@tvercaut
Copy link
Member

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
Copy link
Member Author

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 wyli added CI/CD Low risk nice-to-have features labels May 13, 2021
@wyli
Copy link
Contributor

wyli commented Nov 25, 2021

@vikashg
Copy link

vikashg commented Jan 4, 2024

closing because of inactivity

@vikashg vikashg closed this as completed Jan 4, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
CI/CD Low risk nice-to-have features
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants