Cocogitto 使用教程
cocogittoThe Conventional Commits toolbox项目地址:https://gitcode.com/gh_mirrors/co/cocogitto
1、项目介绍
Cocogitto 是一个用于 Conventional Commits 和 Semver 规范的 CLI 和 GitOps 工具箱。它旨在帮助开发者轻松遵循 Conventional Commits 规范,并自动执行版本管理。Cocogitto 提供了多种功能,包括自动版本升级、生成变更日志、与 GitHub 集成等。
2、项目快速启动
安装
Cocogitto 可以通过多种方式安装,以下是几种常见的安装方法:
Archlinux
pacman -S cocogitto
Cargo
cargo install --locked cocogitto
NixOs
nix-env -iA cocogitto
Void Linux
xbps-install cocogitto
MacOS
brew install cocogitto
创建 Conventional Commits
使用 cog commit
命令可以轻松创建符合 Conventional Commits 规范的提交。例如:
# 使用 cog
cog commit feat "add awesome feature"
# 使用 git
git commit -m "feat: add awesome feature"
自动版本升级
使用 cog bump
命令可以根据提交历史自动确定版本号并执行版本升级。例如:
cog bump
3、应用案例和最佳实践
自动发布
Cocogitto 可以与 GitHub Actions 集成,实现自动发布。以下是一个示例配置:
- name: Semver release
uses: cocogitto/cocogitto-action@main
with:
release: true
git-user: 'Cog Bot'
git-user-email: 'mycoolproject@org.org'
GitHub Bot
Cocogitto 还提供了一个 GitHub Bot (cocogitto-bot
),用于检查 Pull Request 是否符合 Conventional Commits 规范。
4、典型生态项目
Cocogitto 是一个专注于 Conventional Commits 和 Semver 规范的工具,以下是一些与之相关的项目:
- git-cliff: 一个用于生成变更日志的工具。
- convco: 另一个 Conventional Commits 工具。
- koji: 一个用于构建和发布软件的工具。
- semantic-release: 一个自动版本管理和发布的工具。
- commitlint: 一个用于检查提交信息是否符合规范的工具。
- cargo-smart-release: 一个用于自动版本管理和发布的 Rust 工具。
通过这些工具的组合使用,可以进一步提升项目的版本管理和发布效率。
cocogittoThe Conventional Commits toolbox项目地址:https://gitcode.com/gh_mirrors/co/cocogitto