fabienjuif/gitmoji-changelog-rust

Do you use gitmoji? Then generate your changelog with this app!

gitmoji-changelog-rust

Do you use gitmoji? Then generate your changelog with this app!

This is a Rust version of gitmoji-changelog.

[documentation] [repository]

Why

I was sad about the space it takes in a Docker container with the NodeJS version and I am learning Rust: so I was curious and it helps me have a little Rust CLI project to play with.

Try it

With Docker 🐳!

## try it
docker run --rm -v ${PWD}:/repo fabienjuif/gitmoji-changelog

## to see which options you can use:
docker run --rm -v ${PWD}:/repo fabienjuif/gitmoji-changelog --help

With cargo

## install it
cargo install gitmoji-changelog

# maybe you should reset your env here (relaunch your terminal or type `zsh` (or `bash`))

## try it
gitmoji-changelog .

## to see which options you can use:
gitmoji-changelog --help

Roadmap

For now, this project is just a test I do. But if I (or you) want to push this further:

• List commits betweens 2 hashes
• Group commits by "code"
• Group commits by version
• Create a markdown
• Create an incremental markdown
• Detect which tags to start from
• Add author
• Group similar commits
• Links to github

This is a lot of work and I this is surely not worh it!

Commands

This project use a Makefile, here are the main targets:

• package: build the docker image
• ci: build the project (dev mode) and check clippy and rustfmt

You can still use cargo if you want to, eg building the release version with: cargo build --release

gitmoji-changelog-rust's Issues

Smaller docker image?

https://twitter.com/gilescope/status/1079482518796005376

test some projects and see if all is ok

• gitmoji-cli
• gitmoji-changelog
• k-ramel
• k-redux-router

missing git tags when there's some

Hi there ! I just literally tried out your tool and got this error (NoTag) while I do actually have tags in my repo, e.g. : v0.2.2.
My first assumption is that the format of my tags does not match with gitmoji-changelog-rust's expectations, or am I missing something ?

links to github

or gitlab
or bitbucket

(looking for remote "origin")

the older version is empty

add some unit test

Notice the user if there is no tag

Print a nice message telling the users their repository needs to have at least one tag unless they use the release option.

to_markdown should return Result<String, std::Error>?

empty changelog if there is not tag

group similar commits

levenshtein