DEV Community

loading...
Cover image for A changelog generator for gitmoji convention

A changelog generator for gitmoji convention

🦁 Yvonnick FRIN
Senior frontend engineer at @Sterblue. I'm a @NantesJS meetup co-organizer on my spare time.
Originally published at yvonnickfrin.dev Updated on ・2 min read

gitmoji

It is a commit message convention created by Carlos Cuesta 😎. It describes the purpose of this convention on gitmoji's repository on GitHub:

Gitmoji is an initiative to standardize and explain the use of emojis on GitHub commit messages.

Using emojis on commit messages provides an easy way of identifying the purpose or intention of a commit with only looking at the emojis used. As there are a lot of different emojis I found the need of creating a guide that can help to use emojis easier.

gitmoji-changelog

With Benjamin Petetot and Fabien Juif we worked on a command line tool that generates changelog files for javascript projects following gitmoji convention. We simply named it gitmoji-changelog 😀.

gitmoji-changelog usage

Here is an example of generated changelog using gitmoji-changelog

You can find out more about usage on our repository 👌!

2.0 is in alpha 🎉

gitmoji-changelog is still evolving. We are currently working on a version 2.0.0 💪 It is already available in alpha 🎉

You can find out new features in our changelog 😉!

To test it you can install the alpha version:

npm install -g gitmoji-changelog@alpha
Enter fullscreen mode Exit fullscreen mode

Feedback or ideas are appreciated 🙏 Please tweet me if you have questions @YvonnickFrin!

Want to support ? Don't forget to leave a ⭐️

Discussion (1)

Collapse
markel profile image
Markel F.

Just discovered Gitmoji, love it 👀

Forem Open with the Forem app