Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/frinyvonnick/gitmoji-changelog

A changelog generator for gitmoji 😜
https://github.com/frinyvonnick/gitmoji-changelog

changelog cli commit commit-conventions emoji gitmoji hacktoberfest javascript nantes node semver

Last synced: 3 days ago
JSON representation

A changelog generator for gitmoji 😜

Host: GitHub
URL: https://github.com/frinyvonnick/gitmoji-changelog
Owner: frinyvonnick
License: mit
Created: 2018-08-21T09:37:11.000Z (over 6 years ago)
Default Branch: master
Last Pushed: 2024-05-23T14:53:21.000Z (8 months ago)
Last Synced: 2025-01-11T17:07:05.559Z (10 days ago)
Topics: changelog, cli, commit, commit-conventions, emoji, gitmoji, hacktoberfest, javascript, nantes, node, semver
Language: JavaScript
Homepage: https://www.npmjs.com/package/gitmoji-changelog
Size: 22 MB
Stars: 390
Watchers: 13
Forks: 49
Open Issues: 48
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

        ![gitmoji-changelog logo](https://raw.githubusercontent.com/frinyvonnick/gitmoji-changelog/master/misc/logo.png)



  

  

    

  

  

    

  



> Generate changelog for repositories using [gitmoji](https://gitmoji.carloscuesta.me/) commits convention.

![gitmoji-changelog usage example](https://raw.githubusercontent.com/frinyvonnick/gitmoji-changelog/master/misc/example.gif)

## 🚀 Usage

Make sure you have [npx](https://www.npmjs.com/package/npx) installed (`npx` is shipped by default since npm `5.2.0`)

Run the following command at the root of your project and answer questions. `gitmoji-changelog` uses a [preset system](https://docs.gitmoji-changelog.dev/#/?id=%e2%9a%99%ef%b8%8f-presets) to handle different type of project. The preset used by default is the Node.js one that look for project's information in the `package.json` file.

with npx:

```sh

npx gitmoji-changelog

```

with npm:

```sh

npm install -g gitmoji-changelog

cd my-project

gitmoji-changelog

```

It exists a generic preset that works for every kind of project. It looks for information in a `.gitmoji-changelogrc` file at the root of your project. This file must contain three mandatory properties: `name`, `description` and `version`.

.gitmoji-changelogrc:

```json

{

  "project": {

    "name": "gitmoji-changelog",

    "description": "A changelog generator for gitmoji 😜",

    "version": "2.0.1"

  }

}

```

You can change the preset used by `gitmoji-changelog` with the preset option.

```sh

npx gitmoji-changelog --preset generic

```

## 📖 Documentation

:point_right: The full documentation is available [here](https://docs.gitmoji-changelog.dev).

## ✍ Author

👤 **Yvonnick FRIN (https://yvonnickfrin.dev)**

* Twitter: [@YvonnickFrin](https://twitter.com/YvonnickFrin)

* Github: [@frinyvonnick](https://github.com/frinyvonnick)

## 🤝 Contributing

Contributions, issues and feature requests are welcome!
Feel free to check [issues page](https://github.com/frinyvonnick/gitmoji-changelog/issues). You can also take a look at our [contributing guide](CONTRIBUTING.md).

## 🙏 Show your support

Give a ⭐️ if this project helped you!

You also can add a badge in the README.md of your repository to promote `gitmoji-changelog`. All you need is to copy/past the code below:

```markdown

[![gitmoji-changelog](https://img.shields.io/badge/Changelog-gitmoji-brightgreen.svg)](https://github.com/frinyvonnick/gitmoji-changelog)

```

It will add this badge:  [![gitmoji-changelog](https://img.shields.io/badge/Changelog-gitmoji-brightgreen.svg)](https://github.com/frinyvonnick/gitmoji-changelog)

## ✨ Contributors

Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):

  

    
_{Yvonnick FRIN}
💻

    
_{Benjamin Petetot}
💻

    
_{Fabien JUIF}
💻

    
_{Baptiste Gauduchon}
💻

    
_{Franck Abgrall}
💻

    
_quentinncl
💻

    
_{Logan HAUSPIE}
💻

  

  

    
_{Guillaume Membré}
💻

    
_{Yann Bertrand}
💻

    
_{s n}
💻

    
_{Mathieu TUDISCO}
💻

    
_{Charles-Henri GUERIN}
💻

    
_{Florent Berthelot}
💻

    
_{Emmanuel DEMEY}
💻

  

  

    
_{Christopher Kade}
📝

    
_{Rodion Martynov}
📖

    
_{Daniel Tamkin}
📖

    
_{Erno Salo}
📖

    
_{Mark Lyck}
💻

    
_{Lukáš Horák}
💻

    
_{Julien WITTOUCK}
💻

  

This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome!

## 📝 License

Copyright © 2020 [Yvonnick FRIN (https://github.com/frinyvonnick)](https://github.com/frinyvonnick).


This project is [MIT](https://github.com/frinyvonnick/gitmoji-changelog/blob/master/LICENSE) licensed.

***

_This README was generated with ❤️ by [readme-md-generator](https://github.com/kefranabg/readme-md-generator)_