https://github.com/haunt98/changeloguru

Tool to generate CHANGELOG.md from Conventional Commits.
https://github.com/haunt98/changeloguru

changelog go hacktoberfest

Last synced: 5 months ago
JSON representation

Tool to generate CHANGELOG.md from Conventional Commits.

• Host: GitHub
• URL: https://github.com/haunt98/changeloguru
• Owner: haunt98
• License: mit
• Created: 2020-10-06T09:40:44.000Z (almost 5 years ago)
• Default Branch: main
• Last Pushed: 2025-04-21T06:32:39.000Z (6 months ago)
• Last Synced: 2025-04-21T07:42:14.821Z (6 months ago)
• Topics: changelog, go, hacktoberfest
• Language: Go
• Homepage:
• Size: 439 KB
• Stars: 54
• Watchers: 1
• Forks: 0
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# Changeloguru

[![Go](https://github.com/haunt98/changeloguru/actions/workflows/go.yml/badge.svg)](https://github.com/haunt98/changeloguru/actions/workflows/go.yml)

[![gitleaks](https://github.com/haunt98/changeloguru/actions/workflows/gitleaks.yml/badge.svg)](https://github.com/haunt98/changeloguru/actions/workflows/gitleaks.yml)

[![Go Reference](https://pkg.go.dev/badge/github.com/haunt98/changeloguru.svg)](https://pkg.go.dev/github.com/haunt98/changeloguru)

[![Latest Version](https://img.shields.io/github/v/tag/haunt98/changeloguru)](https://github.com/haunt98/changeloguru/tags)

Tool to generate `CHANGELOG.md`, `CHANGELOG.rst` from

[Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/).

## Install

```sh

go install github.com/haunt98/changeloguru/cmd/changeloguru@latest

```

## Usage

- `--from-ref` is new commit

- `--to-ref` is old commit

Generate log from **future** to the **past**.

```sh

# Help

changeloguru --help

# Generate changelog v1.0.0

changeloguru generate --version v1.0.0

# Generate changelog v2.0.0 from HEAD to tag v1.0.0

changeloguru generate --version v2.0.0 --to-ref v1.0.0

# Generate changelog in dry run mode (without changing anything)

changeloguru generate --version v2.0.0 --to-ref v1.0.0 --dry-run

# Generate changelog in interactive mode (with instruction) and auto push commit, tag

changeloguru generate -i --auto-commit --auto-tag --auto-push

```

## Thanks

- [Command Line Interface Guidelines](https://clig.dev/)

Made with [GoLand](https://www.jetbrains.com/go/). Thanks for supporting open

source projects!