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:

And the last 10 releases have not been documented in

Issue Analytics

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

github_iconTop GitHub Comments

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
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:

  1. 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.

  2. 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:

    Screen Shot 2019-04-18 at 9 35 36 am Screen Shot 2019-04-18 at 9 29 53 am
Read more comments on GitHub >

github_iconTop Results From Across the Web

Changelog entries - GitLab Docs
Each list item, or entry, in our file is generated from the subject line of a Git commit. Commits are included when...
Read more >
Keep a Changelog
There should be an entry for every single version. The same types of changes should be grouped. Versions and sections should be linkable....
Read more >
How To Automatically Generate A Helpful Changelog From ...
Creating a changelog is a usual task if a new software version is going to be released. It contains all the changes which...
Read more >
A Beginner's Guide to Git — What is a Changelog and How to ...
A changelog is a file that shares a chronologically ordered list of the changes you've made on your project. It's often organized by...
Read more >
How to get the changelog entry for last release #786 - GitHub
When standard-version generates new changelog entry, I want to extract this entry and use it to update a gitlab release for that tag...
Read more >

github_iconTop Related Medium Post

No results found

github_iconTop Related StackOverflow Question

No results found

github_iconTroubleshoot Live Code

Lightrun enables developers to add logs, metrics and snapshots to live code - no restarts or redeploys required.
Start Free

github_iconTop Related Reddit Thread

No results found

github_iconTop Related Hackernoon Post

No results found

github_iconTop Related Tweet

No results found

github_iconTop Related Post

No results found

github_iconTop Related Hashnode Post

No results found