immutables icon indicating copy to clipboard operation
immutables copied to clipboard

Keep CHANGELOG.md and Release Notes in sync

Open fschmager opened this issue 5 years ago • 4 comments

Dependabot notified me that a new version of value was available 2.8.9-ea-1 (which itself is an unfortunate naming but that's already being discussed in #1251). I've tried to find out what had changed but couldn't find that version under the Github Releases tab. Only 2.8.8 was listed: Screen Shot 2020-11-30 at 08 35 43

Which lead me to check CHANGELOG.md but the last entry there is for 2.8.1: Screen Shot 2020-11-30 at 08 35 24

Also noticed that the docs refer to 2.8.2 as the latest release: Screen Shot 2020-11-30 at 08 32 12

I wonder if Releases and Changelog could be kept in sync. Or maybe just keep one or derive one from the other? Duplication being the root of all evil and all that.

I realize this might not be highest on your list compared to new features and bug fixes but would go a long way to make it easier to use this amazing library.

fschmager avatar Nov 30 '20 13:11 fschmager

We will probably archive changelog in favor of release notes on tags. Next update will be on 2.9 release, currently we at early access/alpha. thank you!

elucash avatar Dec 01 '20 02:12 elucash

Yes probably we should hide CHANGELOG in favor of github release notes.

Regarding version in immutables docs, the (immutables.org) website is statically generated and I have missed upgrading version variable. I wonder if it can be removed altogether (from website) since keeping in sync several versions can be error-prone, as you have pointed out.

asereda-gs avatar Dec 02 '20 06:12 asereda-gs

To sync version in immutables docs, you can generate last release badge with https://shields.io/category/version For example by using "GitHub release (latest SemVer)" generate this badge ![GitHub release (latest SemVer)](https://img.shields.io/github/v/release/immutables/immutables) GitHub release (latest SemVer)

And it can take account of pre-releases as discuss in #1251

ncoquelet avatar Apr 12 '21 13:04 ncoquelet

good suggestion, thank you! will use it when will get to it

elucash avatar Apr 15 '21 17:04 elucash