https://github.com/rcmachado/changelog
Read, validate and manipulate CHANGELOG.md files that follow keepachangelog.com specification
https://github.com/rcmachado/changelog
changelog changelog-formatter changelog-parser cli golang keepachangelog
Last synced: about 2 months ago
JSON representation
Read, validate and manipulate CHANGELOG.md files that follow keepachangelog.com specification
- Host: GitHub
- URL: https://github.com/rcmachado/changelog
- Owner: rcmachado
- License: mit
- Created: 2018-05-20T22:01:09.000Z (about 7 years ago)
- Default Branch: master
- Last Pushed: 2021-11-11T19:32:58.000Z (over 3 years ago)
- Last Synced: 2025-03-26T06:32:46.961Z (2 months ago)
- Topics: changelog, changelog-formatter, changelog-parser, cli, golang, keepachangelog
- Language: Go
- Homepage:
- Size: 168 KB
- Stars: 46
- Watchers: 1
- Forks: 9
- Open Issues: 18
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# changelog
[](https://coveralls.io/github/rcmachado/changelog?branch=master)
[](https://goreportcard.com/report/github.com/rcmachado/changelog)
`changelog` is a command-line application to read and manipulate
`CHANGELOG.md` files that follows the [keepachangelog.com][] spec.
It can normalize the file (`fmt`), create a release (`release`) and
show a specific version (`show`). See [Usage](#usage) for details.
## Table of Contents
- [Usage](#usage)
- [Installation](#installation)
- [Linux and macOS](#linux-and-macos)
- [Source](#source)
- [Commands](#commands)
- [init](#init)
- [fmt](#fmt)
- [show](#show)
- [release](#release)
- [Formatting](#formatting)
- [Contributing](#contributing)
- [License](#license)
## Usage
```bash
# Initialize a new CHANGELOG.md file
$ changelog init --compare-url=https://github.com/myorg/myrepo/compare/abcdef...1234
# Add a first message under "Added" section
$ changelog added "Initial commit"
# Create release
$ changelog release 0.1.0
```
## Installation
### Linux and macOS
The easiest way to install it is to download the [latest version][]
from GitHub releases.
There are precompiled binaries for macOS and Linux.
### Source
Clone the repository and build the executable:
```bash
make build
```
This will generate a `changelog` binary that can be copied to `/usr/local/bin`:
```bash
cp changelog /usr/local/bin
```
## Commands
```text
changelog manipulate and validate markdown changelog files following the keepachangelog.com specification.
Usage:
changelog [command]
Available Commands:
added Add item under 'Added' section
bundle Bundles files containing unrelased changelog entries
changed Add item under 'Changed' section
deprecated Add item under 'Deprecated' section
fixed Add item under 'Fixed' section
fmt Reformat the change log file
help Help about any command
init Initializes a new changelog
release Change Unreleased to [version]
removed Add item under 'Removed' section
security Add item under 'Security' section
show Show changelog for [version]
Flags:
-f, --filename string Changelog file or '-' for stdin (default "CHANGELOG.md")
-h, --help help for changelog
-o, --output string Output file or '-' for stdout (default "-")
Use "changelog [command] --help" for more information about a command.
```
### init
Outputs a changelog with only preamble and Unreleased version to standard output. You can specify a filename using `--output/-o` flag:
```bash
$ touch CHANGELOG.md
$ changelog init -o CHANGELOG.md --compare-url https://github.com/rcmachado/changelog/compare/abcdef...HEAD
Changelog file 'CHANGELOG.md' created.
```
### fmt
Normalize file format (see [Formatting](#formatting) for the specific
transformation applied):
```bash
changelog fmt
```
### show
Show what will be in the next release:
```bash
changelog show Unreleased
```
Show the change log for a specific version:
```bash
changelog show 1.2.3
```
### release
Create a new release:
```bash
changelog release 1.2.4
```
### Formatting
`fmt` command normalizes the changelog file. The idea is to always have
the same output, no matter how messy the file is. Right now it doesn't
do much, but the plan is to evolve it as a kind of `go fmt` for
changelogs.
Currently, the following transformations are applied:
- Sections are sorted (eg. Added, Changed, etc)
- Version links are put at the bottom of the file
- List bullet is always `-`
## Contributing
Feel free to fork and submit a PR. You can also take a look, at the [Issues][] tab to see some ideas.
## License
Licensed under MIT. See [LICENSE][] file for details.
[keepachangelog.com]: https://keepachangelog.com/
[LICENSE]: ./LICENSE
[Issues]: https://github.com/rcmachado/changelog
[latest version]: https://github.com/rcmachado/changelog/releases/latest