Git-cz

git-cz 是 git-commitizen 的简称

一个习惯性提交命令行工具。

git-cz 提供了与 习惯性提交 一起工作的工具。

该工具仍处于早期开发阶段。它已提供以下命令

• git-cz changelog：创建一个变更日志文件。
• git-cz check：检查一系列提交是否遵循惯例。
• git-cz commit：帮助创建习惯性提交。将提示作用域、描述、主体、破坏性更改和问题。
• git-cz version：查找当前或下一个版本。

安装

从源码构建

cargo install --git https://github.com/ttys3/git-cz.git

下载预构建的二进制文件

下载并将 git-cz 添加到您的 PATH 环境变量

Git 别名

推荐 Git 别名

# use "git cc" for quick commit
git config --global alias.cc 'cz commit'

git config --global alias.ck 'cz check'

git config --global alias.cl 'cz changelog'

git config --global alias.cv 'cz version'

Docker 使用

# build the git-cz image
docker build -t git-cz .
# run it on any codebase
docker run -v "$PWD:/tmp" --workdir /tmp --rm git-cz

在 .gitlab-ci.yml 中使用它

如果您已创建镜像并将其推送到您的私有仓库

git-cz:check:
  stage: test
  image:
    name: 80x86/git-cz:latest
  script:
    - check

工具

变更日志

可以使用习惯性提交生成变更日志。它受到 习惯性变更日志 的启发。配置遵循 习惯性变更日志配置规范

git-cz changelog > CHANGELOG.md

检查

检查一系列修订版本的合规性。

如果某些提交不是习惯性的，它将返回非零退出代码。这在预推送钩子中很有用。

git-cz check $remote_sha..$local_sha

提交

帮助创建习惯性提交。将提示作用域、描述、主体、破坏性更改和问题。

# commit a new feature and then run git commit with the interactive patch switch
git-cz commit --feat -- --patch

版本

当没有提供选项时，它将返回当前版本。当提供 --bump 时，将打印出下一个版本。常规提交用于计算下一个主版本、次版本或补丁版本。如果需要，可以提供 --major、--minor 或 --patch 来覆盖常规。

git-cz version --bump

与发布工具一起使用非常有用，例如 cargo-release

cargo release $(git-cz version --bump)

待办事项

• 自动生成重大变更的说明
• 自定义模板文件夹
• 使用 .versionrc 文件
• 限制到一系列版本
• 对更改日志中的部分进行排序
• 问题引用
• 更好的文档
• 更好的错误处理

谢谢

• 由 Skim 提供的模糊查找器

• 原始代码由 convco 提供

参考

https://www.conventionalcommits.org/en/v1.0.0/

https://github.com/commitizen/conventional-commit-types/blob/master/index.json

相关工作

https://github.com/commitizen/cz-cli

https://github.com/goreleaser/chglog

https://github.com/ahmadawais/Emoji-Log