question-mark
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.

It would be awesome if a changelog.md was added and Github releases were used to keep track of changes.

A common practice is to track changes under a next version heading at the top of changelog.md, then when ready to release:

  1. Do a commit bumping the version:
  • New version in package.json.
  • Rename the next heading in changelog.md to the new version.
  1. Create a new Github release. Follow the “Tagging suggestions” in the sidebar, and copy-paste the markdown from the change log into the description.
  2. Run npm publish.

You can see that process in action at jaydenseric/apollo-upload-client.

Issue Analytics

  • State:closed
  • Created 6 years ago
  • Reactions:2
  • Comments:6 (3 by maintainers)

github_iconTop GitHub Comments

1reaction
fridayscommented, Jul 8, 2017

Great idea. Thank you for explaining so well.

0reactions
fridayscommented, Oct 7, 2017

I just made a github release using release, that was easy. Thanks again!

Read more comments on GitHub >

github_iconTop Results From Across the Web

Keep a Changelog
A changelog is a file which contains a curated, chronologically ordered list of notable changes for each version of a project. Why keep...
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 >
What is Changelog & Example of ARN Change Log Format
What is a good changelog? · Always include a complete history of notable changes. · Include the “when” for each of the updates....
Read more >
Sample CHANGELOG - gists · GitHub
Change Log ​​ All notable changes to this project will be documented in this file. The format is based on Keep a Changelog...
Read more >
Changelog entries - GitLab Docs
Writing good changelog entries ; Go to a project order. · Show a user's starred projects at the top of the “Go to...
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 Dev.to Post

No results found

github_iconTop Related Hashnode Post

No results found