changelog

crates.io version build status downloads docs.rs docs

Changelog generator.

Why?

Keeping track of what changed between versions can be tricky. So changelogs exist to document those changes for you. But writing changelogs can take a lot of time, which not everyone has. Which means a lot of projects choose not to keep a changelog.

So this project exists as a best-effort to generate changelogs for you. It doesn't require custom commit styles to work. Nor does it ask you to manually track changes in several places.

Instead we automate as much as possible, and present a changelog that's both easy on the eyes, and easy to use. It's not intended to replace manual changelogs, but instead provide an option to keep a changelog for projects that otherwise wouldn't. We hope you find this useful!

Usage

```txt changelog 0.1.2 Command line parser.

USAGE: changelog [FLAGS] [OPTIONS] [path]

FLAGS: -h, --help Prints help information -P, --pretty Enable pretty printing -q, --quiet Suppress all log output -V, --version Prints version information -v, --verbosity Print more log output

OPTIONS: -o, --out Write output to file

ARGS: Project directory [default: .] ```

Installation

sh $ cargo install changelog

License

MIT OR Apache-2.0