Skip to content

Latest commit

 

History

History
43 lines (28 loc) · 1.56 KB

README.md

File metadata and controls

43 lines (28 loc) · 1.56 KB
Raw

commits to changelogs

Go Report Card

Philosophy

  • Work on all major operating systems
  • Not platform dependent, not tied to Github, Gitlab, or anything. It's just markdown.
  • Ability to generate change logs between version tags
  • Handle release versioning of the project
  • Stay small

Installation

Using goblin.run

; curl -sfL https://goblin.run/github.com/barelyhuman/commitlog/v3 | sh

go

If you have go installed, you can use the below command

go install github.com/barelyhuman/commitlog/v3@latest

Why

Every language has it's own isolated version of a tool like this, for someone who works with multiple languages, it's easier to have the same tool working everywhere, without having to setup something get it working. There's an even tighter scoped version of this, nimclog.

The point of the tool is not to create super descriptive changelogs for you but to help your changelogs have enough information for you as a developer to be able to write proper changelogs while having references to the changes in one place.

Documentation

The documentation can be read from the docs folder of the repository, or on the website

License

MIT