orhun/git-cliff
1
1
Fork 0
mirror of https://github.com/orhun/git-cliff.git synced 2024-09-11 06:55:38 +03:00
Code Issues Projects Releases Wiki Activity
A highly customizable Changelog Generator that follows Conventional Commit specifications ⛰️
748 Commits 23 Branches 115 Tags 31 MiB
Rust 91.3%
TypeScript 3.9%
JavaScript 2.5%
Dockerfile 0.7%
Shell 0.6%
Other 1%
edd3c30000
Go to file
Jean SIMARD edd3c30000
docs(changelog): fix typos (#316) 
* docs(changelog): fix typos

fixes #310

* docs(release): explain how typos are auto-corrected

* feat(ci): check/install 'typos' for release

---------

Co-authored-by: mergify[bot] <37929162+mergify[bot]@users.noreply.github.com>
2023-10-19 15:09:45 +02:00
.github docs(changelog): fix typos (#316) 2023-10-19 15:09:45 +02:00
config docs: update Tera links to the new URL (#272) 2023-09-08 15:22:14 +02:00
examples docs: update Tera links to the new URL (#272) 2023-09-08 15:22:14 +02:00
git-cliff feat(changelog): support bumping the semantic version via --bump (#309) 2023-10-13 14:43:55 +02:00
git-cliff-core feat(command): log the output of failed external commands 2023-10-19 15:57:18 +03:00
npm chore(release): prepare for v1.3.1 2023-09-30 17:03:47 +03:00
pypi chore(pypi): publish git-cliff on PyPI (#158) 2023-08-16 09:53:31 +02:00
website docs(website): add instructions for installing the latest git version 2023-10-17 16:23:35 +03:00
.dockerignore chore(ci): update the link checker configuration (#315) 2023-10-14 18:22:29 +02:00
.editorconfig chore(editorconfig): fix editorconfig syntax 2023-04-26 16:47:48 +03:00
.gitignore chore(project): remove unnecessary Cargo.lock entry from .gitignore 2021-10-22 16:49:59 +03:00
.lycheeignore chore(ci): update the link checker configuration (#315) 2023-10-14 18:22:29 +02:00
Cargo.lock chore(deps): bump next_version from 0.2.8 to 0.2.9 (#320) 2023-10-16 22:18:54 +00:00
Cargo.toml chore(deps): bump regex from 1.10.0 to 1.10.2 (#319) 2023-10-16 22:18:19 +00:00
CHANGELOG.md docs(changelog): fix typos (#316) 2023-10-19 15:09:45 +02:00
cliff.toml docs(changelog): fix typos (#316) 2023-10-19 15:09:45 +02:00
CNAME Create CNAME 2022-12-26 17:24:46 +01:00
CODE_OF_CONDUCT.md chore(project): rename 2021-05-30 01:45:03 +03:00
codecov.yml fix(project): use the correct branch for codecov (#65) 2022-03-13 13:17:59 +03:00
CONTRIBUTING.md docs(license): re-license under the MIT + Apache 2.0 license (#303) 2023-09-30 15:48:24 +02:00
Dockerfile chore(docker): update versions in Dockerfile 2023-08-30 18:02:58 +03:00
LICENSE-APACHE docs(license): re-license under the MIT + Apache 2.0 license (#303) 2023-09-30 15:48:24 +02:00
LICENSE-MIT docs(license): re-license under the MIT + Apache 2.0 license (#303) 2023-09-30 15:48:24 +02:00
README.md docs(readme): add link to emacs package support git-cliff (#307) 2023-10-09 18:05:43 +02:00
RELEASE.md chore(release): set the new version in release script 2021-06-30 01:26:32 +03:00
release.sh docs(changelog): fix typos (#316) 2023-10-19 15:09:45 +02:00
rust-toolchain.toml chore(ci): return to nightly builds (#73) 2022-03-29 14:44:45 +03:00
rustfmt.toml chore(fmt): remove normalize_comments from rustfmt.toml 2021-06-04 03:11:15 +03:00
SECURITY.md docs(github): add security policy 2023-04-04 22:38:28 +03:00

README.md




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.

preview

Documentation

Learn how to use git-cliff from the documentation.

In The Media

Editor Support

  • git-cliff.el - Genarate, 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.

Contributors

Thanks goes to these wonderful people ✨

Made with contrib.rocks.

License

Licensed under either of Apache License Version 2.0 or The MIT License at your option.

Copyright

Copyright © 2021-2023, git-cliff contributors