search

tinkerbell / playground

Example deployments of the Tinkerbell Stack for use as playground environments
Apache License 2.0
132 stars 87 forks source link

Figure out how to generate a changelog #35

Closed gianarb closed 3 years ago

gianarb commented 3 years ago

Expected Behaviour

As part of the release CI pipeline, we should have a changelog that collects and grab updates from all the projects: tink, osie, Hegel, boots.

I think the list of PR titles is enough but I want to put some extra care into the breaking change. They should be listed in their own section so the user will be able to figure how what they are and what they have to do to update (as part of the content of every PR that contains breaking changes there is a section that explains how to mitigate it)

Current Behaviour

We do not have it

Possible Solution

Using some tool that does that automatically or writes a custom binary.

tstromberg commented 3 years ago

I've previously used http://github.com/corneliusweig/release-notes for generating basic release notes that can be hand-massaged later. It assumes that there are git tags for each release, however. The code is pretty trivial to modify if necessary.

jacobweinstock commented 3 years ago

I believe this is resolved by https://github.com/tinkerbell/sandbox/pull/109. If not, please re-open.