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

Generate a project changelog #239

Open
cdamus opened this issue Jul 28, 2022 · 0 comments
Open

Generate a project changelog #239

cdamus opened this issue Jul 28, 2022 · 0 comments
Labels
enhancement New feature or request modelserver EMF.cloud Model Server

Comments

@cdamus
Copy link
Contributor

cdamus commented Jul 28, 2022

It is common for software releases to include Release Notes that highlights significant improvements and fixes, and often also an accompanying changelog that itemizes all changes at a finer level of detail.

A changelog should be generatable from the commit history, with links to issues, because we generally describe the nature of a change in the commit and link it to the issue that it addresses. This, then, could be published either via GH Pages or some other means for reference for each release.

One important consideration that a solution should address is API or behaviour breaking changes, especially in the incubation phase where these sorts of changes are more common. Perhaps commits that make such changes could be tagged with #apibreak or #breaking or some such that a changelog generator could pick up to highlight these changes and possibly collect them into a "breaking changes" section.

@cdamus cdamus added enhancement New feature or request modelserver EMF.cloud Model Server labels Jul 28, 2022
@ndoschek ndoschek added this to the 0.8.0 Stable Release milestone Aug 23, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request modelserver EMF.cloud Model Server
Projects
None yet
Development

No branches or pull requests

2 participants