Add a change log
See original GitHub issueIt 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:
- Do a commit bumping the version:
- New version in
package.json
. - Rename the
next
heading inchangelog.md
to the new version.
- Create a new Github release. Follow the “Tagging suggestions” in the sidebar, and copy-paste the markdown from the change log into the description.
- Run
npm publish
.
You can see that process in action at jaydenseric/apollo-upload-client.
Issue Analytics
- State:
- Created 6 years ago
- Reactions:2
- Comments:6 (3 by maintainers)
Top 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 >Top Related Medium Post
No results found
Top Related StackOverflow Question
No results found
Troubleshoot Live Code
Lightrun enables developers to add logs, metrics and snapshots to live code - no restarts or redeploys required.
Start FreeTop Related Reddit Thread
No results found
Top Related Hackernoon Post
No results found
Top Related Tweet
No results found
Top Related Dev.to Post
No results found
Top Related Hashnode Post
No results found
Top GitHub Comments
Great idea. Thank you for explaining so well.
I just made a github release using
release
, that was easy. Thanks again!