git-cliff

<p align="center"> <a href="https://git-cliff.org"> <img src="https://yellow-cdn.veclightyear.com/835a84d5/42295506-54fe-4a0d-b4cc-f520598b07da.png" width="300"></a> <br> <a href="https://github.com/orhun/git-cliff/releases"> <img src="https://img.shields.io/github/v/release/orhun/git-cliff?style=flat&labelColor=1C2C2E&color=C96329&logo=GitHub&logoColor=white"> </a> <a href="https://crates.io/crates/git-cliff/"> <img src="https://img.shields.io/crates/v/git-cliff?style=flat&labelColor=1C2C2E&color=C96329&logo=Rust&logoColor=white"> </a> <a href="https://codecov.io/gh/orhun/git-cliff"> <img src="https://img.shields.io/codecov/c/gh/orhun/git-cliff?style=flat&labelColor=1C2C2E&color=C96329&logo=Codecov&logoColor=white"> </a> <br> <a href="https://github.com/orhun/git-cliff/actions?query=workflow%3A%22Continuous+Integration%22"> <img src="https://img.shields.io/github/actions/workflow/status/orhun/git-cliff/ci.yml?style=flat&labelColor=1C2C2E&color=BEC5C9&logo=GitHub%20Actions&logoColor=BEC5C9"> </a> <a href="https://github.com/orhun/git-cliff/actions?query=workflow%3A%22Continuous+Deployment%22"> <img src="https://img.shields.io/github/actions/workflow/status/orhun/git-cliff/cd.yml?style=flat&labelColor=1C2C2E&color=BEC5C9&logo=GitHub%20Actions&logoColor=BEC5C9&label=deploy"> </a> <a href="https://hub.docker.com/r/orhunp/git-cliff"> <img src="https://img.shields.io/github/actions/workflow/status/orhun/git-cliff/docker.yml?style=flat&labelColor=1C2C2E&color=BEC5C9&label=docker&logo=Docker&logoColor=BEC5C9"> </a> <a href="https://docs.rs/git-cliff-core/"> <img src="https://img.shields.io/docsrs/git-cliff-core?style=flat&labelColor=1C2C2E&color=BEC5C9&logo=Rust&logoColor=BEC5C9"> </a> <br> </p> <h4 align="center"> <a href="https://git-cliff.org/docs">文档</a> | <a href="https://git-cliff.org">网站</a> </h4>

git-cliff 可以通过利用约定式提交以及基于正则表达式的自定义解析器从 Git 历史记录生成更新日志文件。可以使用配置文件自定义更新日志模板以匹配所需的格式。

文档

从文档中了解如何使用 git-cliff。

• 安装
• 使用
• 配置
• 模板

媒体报道

• 用 git-cliff 将 Git 提交转化为更新日志 - RustLab 2023（演讲）
• 与 git-cliff 的 Orhun 的访谈 - Console #141（新闻简报）
• KaiCode 开源节 2024（第二名获奖者）

编辑器支持

• git-cliff.el - 在 Emacs 中生成、更新和发布更新日志

类似/相关项目

• git-journal - Git 提交消息和更新日志生成框架
• clog-cli - 从 Git 提交历史生成漂亮的更新日志
• relnotes - 自动为项目生成发布说明的工具
• cocogitto - 用于约定式提交和语义化版本规范的 CLI 工具集
• cliff-jumper - 一个 NodeJS CLI 工具，结合了 git-cliff 和 conventional-recommended-bump，用于语义化地升级 NodeJS 包并生成由 git-cliff 驱动的更新日志
• release-plz - 从 CI 发布 Rust 包
• git-changelog-command-line - 使用约定式提交生成更新日志并确定下一个版本
• git-changelog：使用 Jinja2 模板的自动更新日志生成器

贡献者

感谢这些了不起的人 ✨

<a href="https://github.com/orhun/git-cliff/graphs/contributors"> <img src="https://contrib.rocks/image?repo=orhun/git-cliff" /> </a>

使用 contrib.rocks 制作。

社交媒体

<a href="https://discord.gg/W3mAwMDWH4"> <img src="https://yellow-cdn.veclightyear.com/835a84d5/a458849a-3321-4625-a664-31df03ff65f3.png?style=banner2"> </a> <br> <a href="https://matrix.to/#/#git-cliff:matrix.org"> <img src="https://img.shields.io/matrix/git-cliff:matrix.org?style=flat&labelColor=1C2C2E&color=BEC5C9&logo=matrix&logoColor=BEC5C9&label=加入%20matrix"> </a> <a href="https://discord.gg/W3mAwMDWH4"> <img src="https://img.shields.io/discord/1093977388892819553?style=flat&labelColor=1C2C2E&color=BEC5C9&logo=discord&logoColor=BEC5C9&label=加入%20discord"> </a> <a href="https://twitter.com/git_cliff"> <img src="https://img.shields.io/twitter/follow/git_cliff?style=flat&labelColor=1C2C2E&color=BEC5C9&logo=twitter&logoColor=BEC5C9"> </a> <a href="https://fosstodon.org/@git_cliff"> <img src="https://img.shields.io/mastodon/follow/111545487385097711?domain=https%3A%2F%2Ffosstodon.org&style=flat&labelColor=1C2C2E&color=BEC5C9&logo=mastodon&logoColor=BEC5C9"> </a>

许可证

根据您的选择，可以使用 Apache 许可证 2.0 版 或 MIT 许可证 中的任何一个进行许可。

版权

版权所有 © 2021-2024，git-cliff 贡献者