https://github.com/fboulnois/git-changelog
A Rust program to generate a CHANGELOG.md from semantic git commits
https://github.com/fboulnois/git-changelog
changelog changelog-generator git rust
Last synced: 3 months ago
JSON representation
A Rust program to generate a CHANGELOG.md from semantic git commits
- Host: GitHub
- URL: https://github.com/fboulnois/git-changelog
- Owner: fboulnois
- License: mpl-2.0
- Created: 2022-12-22T01:38:42.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2022-12-28T15:57:21.000Z (almost 3 years ago)
- Last Synced: 2025-06-18T08:51:31.363Z (4 months ago)
- Topics: changelog, changelog-generator, git, rust
- Language: Rust
- Homepage:
- Size: 17.6 KB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# `git-changelog`
A rust program to generate a `CHANGELOG.md` from semantic git commits. Check the
[`CHANGELOG.md`](CHANGELOG.md) in this repository for an example.
## How to build:
Type `cargo build --release`. Versioned releases are also available on [Github](https://github.com/fboulnois/git-changelog/releases).
## How to use:
1. Copy `git-changelog` to `/usr/local/bin` and ensure it is available on the `$PATH`
2. Create an alias to `git-changelog` :
```sh
git config --global alias.changelog /usr/local/bin/git-changelog
```
3. In any git repository, create a `CHANGELOG.md` using `git changelog`