https://github.com/barelyhuman/commitlog

Generate Changelogs from Commits (CLI)
https://github.com/barelyhuman/commitlog

changelog changelog-generator commit commits developer-tools markdown productivity

Last synced: 11 days ago
JSON representation

Generate Changelogs from Commits (CLI)

• Host: GitHub
• URL: https://github.com/barelyhuman/commitlog
• Owner: barelyhuman
• License: mit
• Created: 2020-12-26T21:43:32.000Z (almost 4 years ago)
• Default Branch: main
• Last Pushed: 2024-05-03T13:27:46.000Z (6 months ago)
• Last Synced: 2024-10-17T00:22:59.170Z (25 days ago)
• Topics: changelog, changelog-generator, commit, commits, developer-tools, markdown, productivity
• Language: Go
• Homepage: https://barelyhuman.github.io/commitlog/
• Size: 285 KB
• Stars: 80
• Watchers: 3
• Forks: 3
• Open Issues: 5
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

        


  

commits to changelogs


[![Go Report Card](https://goreportcard.com/badge/github.com/barelyhuman/commitlog)](https://goreportcard.com/report/github.com/barelyhuman/commitlog)

## 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](https://goblin.run)

```sh

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

```

### go

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

```sh

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](https://github.com/barelyhuman/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](https://barelyhuman.github.io/commitlog)

## License

[MIT](/LICENSE)