Stuck on an issue?

Lightrun Answers was designed to reduce the constant googling that comes with debugging 3rd party libraries. It collects links to all the places you might be looking at while hunting down a tough bug.

And, if you’re still stuck at the end, we’re happy to hop on a call to see how we can help out.

Add changelog entries for recent releases

See original GitHub issue

None of the GitHub releases have descriptions:

https://github.com/BitGo/BitGoJS/releases

And the last 10 releases have not been documented in RELEASE_NOTES.md.

Issue Analytics

State:
Created 4 years ago
Reactions:1
Comments:5 (3 by maintainers)

Top GitHub Comments

1reaction

tylerlevinecommented, Apr 17, 2019

Thanks for the heads up. We typically update the release notes within 48 hours of release, but are a little slower this time around.

I will create a PR to update the release notes for the following versions later today:

4.49.1, 4.49.2
5.0.1, 5.0.2, 5.0.3, 5.0.4

0reactions

jaydensericcommented, Apr 17, 2019

Thanks for the update 😃

Instead of adding descriptions to the releases page, I’d rather have all the release notes in the repo instead.

The changelog definitely should be versioned, yes. Best practice is to also copy the changelog entries into the GitHub release descriptions:

It gets tiring having to try to hunt down release notes in different places in a lot of repos when updating dependencies, it is always a relief when the GitHub release has all the info.
When people watch the repo for releases, it is a much better experience when the release notification email has details about the release instead of being blank. Here is an example with Next.js: