mirror of
https://github.com/orhun/git-cliff.git
synced 2024-09-11 15:05:30 +03:00
A highly customizable Changelog Generator that follows Conventional Commit specifications ⛰️
changelogchangelog-generatorcommitconventional-changelogconventional-commitsgeneratorhacktoberfestkeepachangelogrustsemverstarred-orhun-repostarred-repo
50c240c25b
* feat: Enable footer-based commit parsing
Enable defining parsers for a commit's footer, similar to the already-
present commit parsers for a commit's message or body.
For example:
```toml
commit_parsers = [
{ footer = "changelog: ignore", skip = true },
]
```
Due to an inconsistency between the conventional commits specification
and its reference parser, footers are currently interpreted as
`key:value` instead of the (correct) `key: value`. See
https://github.com/conventional-commits/parser/issues/47 for details.
As a future-proof workaround, you can use `key: ?value` in the regex.
* chore: fix typo
---------
Co-authored-by: Orhun Parmaksız <orhunparmaksiz@gmail.com>
|
||
|---|---|---|
| .github | ||
| config | ||
| examples | ||
| git-cliff | ||
| git-cliff-core | ||
| npm | ||
| pypi | ||
| website | ||
| .cliffignore | ||
| .dockerignore | ||
| .editorconfig | ||
| .gitignore | ||
| .lycheeignore | ||
| Cargo.lock | ||
| Cargo.toml | ||
| CHANGELOG.md | ||
| cliff.toml | ||
| CNAME | ||
| CODE_OF_CONDUCT.md | ||
| codecov.yml | ||
| CONTRIBUTING.md | ||
| Dockerfile | ||
| LICENSE-APACHE | ||
| LICENSE-MIT | ||
| README.md | ||
| RELEASE.md | ||
| release.sh | ||
| rust-toolchain.toml | ||
| rustfmt.toml | ||
| SECURITY.md | ||
| typos.toml | ||
Documentation | Website
git-cliff can generate changelog files from the Git history by utilizing conventional commits as well as regex-powered custom parsers. The changelog template can be customized with a configuration file to match the desired format.
Documentation
Learn how to use git-cliff from the documentation.
In The Media
- Turning Git commits into changelog with git-cliff - RustLab 2023 (Talk)
- An Interview with Orhun of git-cliff - Console #141 (Newsletter)
Editor Support
- git-cliff.el - Generate, update and release changelog in Emacs
Similar/Related Projects
- git-journal - The Git Commit Message and Changelog Generation Framework
- clog-cli - Generate beautiful changelogs from your Git commit history
- relnotes - A tool to automatically generate release notes for your project.
- cocogitto - A set of CLI tools for the conventional commit and semver specifications.
- cliff-jumper - A NodeJS CLI tool that combines git-cliff and conventional-recommended-bump to semantically bump a NodeJS package and generate a git-cliff powered changelog.
- release-plz - Release Rust packages from CI.
- git-changelog-command-line - Generate changelog and determine next version with conventional commits.
Contributors
Thanks goes to these wonderful people ✨
Made with contrib.rocks.
Socials
License
Licensed under either of Apache License Version 2.0 or The MIT License at your option.
Copyright
Copyright © 2021-2024, git-cliff contributors