Yarn: An usable Changelog is missing

Created on 27 Sep 2018 · 9Comments · Source: yarnpkg/yarn

Do you want to request a feature or report a bug?
Feature

What is the current behavior?
Yarn does not have a reliable / proper / up-to-date changelog

If the current behavior is a bug, please provide the steps to reproduce.
I can not know what are the major / breaking changes in the latest yarn versions

What is the expected behavior?
Using either a CHANGELOG.md file or the Github release page (ideally both), I would like to be able to know what are the major changes in new versions, as well as the (potentially) breaking ones.
This is missing for the last published versions, and for some others (like 1.10.0) a mere list of commits, which is not very useful as an overview.
This should be part of the release process. For example, Babel has a nice (and semi-automated) way of doing this: https://github.com/babel/babel/releases/tag/v7.1.0

cat-documentation cat-feature

Source

renchap

👍4

All 9 comments

Some changelogs are here: https://github.com/yarnpkg/yarn/releases. However, it looks like not every release has a changelog.

Daniel15 on 30 Sep 2018

Correct, and the changelogs are not very useful when present (see v1.10.0, as described above.

It should be part of the release process.

renchap on 30 Sep 2018

Hmm, should every merged PR make a commit to update a CHANGELOG pre-merge?

Seems like it would be more difficult for maintainers to do it themselves.

olingern on 1 Oct 2018

👍1

Yeah I think we'll start doing a CHANGELOG.md.

arcanis on 1 Oct 2018

👍1

https://keepachangelog.com/en/1.0.0/ has good guidelines for a CHANGELOG file.
I would also advise to edit it slightly to add a summary for the version before releasing, this really helps users to understand what happened during the release without reading the whole entry (and often needing to look at the linked PRs)

renchap on 1 Oct 2018

👍1