freenowtech / wave

Design System of FREE NOW
https://wave.free-now.com
Apache License 2.0
64 stars 22 forks source link

docs: correct changelog #415

Closed martimalek closed 5 months ago

martimalek commented 5 months ago

What

Remove > 2.0 entries in the changelog and leave just one pointing to the migration guide

Why

The changelog in next has been incorrect for a long time, due to repeated conflicts between next and main the changelog would almost never auto-update itself through semantic-release. Instead of offering a half-complete changelog IMO it's better to just add one entry for 2.x and point to out migration guide, where there already is a list of breaking changes

How

Remove previous > 2.0 changelog entries and add one that points to the 2.0 migration guide.

Alternative

Alternatively we could keep the previous entries and try to "complete" the changlog with an entry for each breaking change, let me know if you think that's better.

github-actions[bot] commented 5 months ago

:tada: This PR is included in version 2.1.0 :tada:

The release is available on:

Your semantic-release bot :package::rocket: