Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/orhun/git-cliff
A highly customizable Changelog Generator that follows Conventional Commit specifications ⛰️
https://github.com/orhun/git-cliff
changelog changelog-generator commit conventional-changelog conventional-commit conventional-commits generator git git-cliff hacktoberfest keepachangelog rust semver
Last synced: 10 days ago
JSON representation
A highly customizable Changelog Generator that follows Conventional Commit specifications ⛰️
- Host: GitHub
- URL: https://github.com/orhun/git-cliff
- Owner: orhun
- License: apache-2.0
- Created: 2021-05-30T11:11:58.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2024-11-30T21:10:38.000Z (12 days ago)
- Last Synced: 2024-11-30T22:28:24.700Z (11 days ago)
- Topics: changelog, changelog-generator, commit, conventional-changelog, conventional-commit, conventional-commits, generator, git, git-cliff, hacktoberfest, keepachangelog, rust, semver
- Language: Rust
- Homepage: https://git-cliff.org
- Size: 14.8 MB
- Stars: 9,370
- Watchers: 40
- Forks: 200
- Open Issues: 75
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE-APACHE
- Code of conduct: CODE_OF_CONDUCT.md
- Codeowners: .github/CODEOWNERS
- Security: SECURITY.md
Awesome Lists containing this project
- awesome-ccamel - orhun/git-cliff - A highly customizable Changelog Generator that follows Conventional Commit specifications ⛰️ (Rust)
- awesome-rust - git-cliff - cliff/actions](https://img.shields.io/github/actions/workflow/status/orhun/git-cliff/ci.yml?branch=main&label=build) (Development tools / Web Servers)
- awesome-rust-cn - git-cliff
- awesome-starred - orhun/git-cliff - A highly customizable Changelog Generator that follows Conventional Commit specifications ⛰️ (rust)
- awesome-list - git-cliff
- awesome-rust - git-cliff - A highly customizable Changelog Generator that follows Conventional Commit specifications  (Development tools / Web Servers)
- jimsghstars - orhun/git-cliff - A highly customizable Changelog Generator that follows Conventional Commit specifications ⛰️ (Rust)
- fucking-awesome-rust - git-cliff - A highly customizable Changelog Generator that follows Conventional Commit specifications  (Development tools / Web Servers)
- my-awesome - orhun/git-cliff - generator,commit,conventional-changelog,conventional-commit,conventional-commits,generator,git,git-cliff,hacktoberfest,keepachangelog,rust,semver pushed_at:2024-12 star:9.4k fork:0.2k A highly customizable Changelog Generator that follows Conventional Commit specifications ⛰️ (Rust)
- StarryDivineSky - orhun/git-cliff - cliff 可以通过利用常规提交以及正则表达式驱动的自定义解析器从 Git 历史记录生成更改日志文件。可以使用配置文件自定义 changelog 模板以匹配所需的格式。 (网络服务 / 网络服务_其他)
README
Documentation |
Website
**git-cliff** can generate [changelog](https://en.wikipedia.org/wiki/Changelog) files from the [Git](https://git-scm.com/) history by utilizing [conventional commits](https://git-cliff.org/docs/configuration/git#conventional_commits) as well as regex-powered [custom parsers](https://git-cliff.org/docs/configuration/git#commit_parsers). The [changelog template](https://git-cliff.org/docs/category/templating) can be customized with a [configuration file](https://git-cliff.org/docs/configuration) to match the desired format.
## Documentation
Learn how to use **git-cliff** from the [documentation](https://git-cliff.org/docs).
- [Installation](https://git-cliff.org/docs/installation/)
- [Usage](https://git-cliff.org/docs/usage/examples)
- [Configuration](https://git-cliff.org/docs/configuration)
- [Templating](https://git-cliff.org/docs/category/templating)
## In The Media
- [Turning Git commits into changelog with git-cliff](https://www.youtube.com/watch?v=RWh8qbiLRts) - RustLab 2023 (Talk)
- [An Interview with Orhun of git-cliff](https://console.substack.com/p/console-141) - Console #141 (Newsletter)
- [KaiCode Open Source Festival 2024](https://www.kaicode.org/2024.html) (Second place winner)
- [git-cliff: The Smart Way to Handle Changelogs](https://medium.com/@toniomasotti/git-cliff-96449950db48) (Blog post)
## Editor Support
- [git-cliff.el](https://github.com/liuyinz/git-cliff.el) - Generate, update and release changelog in Emacs
## Similar/Related Projects
- [git-journal](https://github.com/saschagrunert/git-journal) - The Git Commit Message and Changelog Generation Framework
- [clog-cli](https://github.com/clog-tool/clog-cli) - Generate beautiful changelogs from your Git commit history
- [relnotes](https://crates.io/crates/relnotes) - A tool to automatically generate release notes for your project.
- [cocogitto](https://github.com/oknozor/cocogitto) - A set of CLI tools for the conventional commit and semver specifications.
- [cliff-jumper](https://github.com/favware/cliff-jumper) - A NodeJS CLI tool that combines git-cliff and
[conventional-recommended-bump](https://github.com/conventional-changelog/conventional-changelog/tree/master/packages/conventional-recommended-bump)
to semantically bump a NodeJS package and generate a git-cliff powered changelog.
- [release-plz](https://github.com/MarcoIeni/release-plz) - Release Rust packages from CI.
- [git-changelog-command-line](https://github.com/tomasbjerre/git-changelog-command-line) - Generate changelog and determine next version with conventional commits.
- [git-changelog](https://github.com/pawamoy/git-changelog): Automatic Changelog generator using Jinja2 templates.
## Contributors
Thanks goes to these wonderful people ✨
Made with [contrib.rocks](https://contrib.rocks).
## Socials
## License
Licensed under either of [Apache License Version 2.0](./LICENSE-APACHE) or [The MIT License](./LICENSE-MIT) at your option.
## Copyright
Copyright © 2021-2024, [git-cliff contributors](mailto:[email protected])