Git Flow

为Cargo和Yarn工作空间提供基于GitHub的git-flow的CLI工具。

开发中

doppler setup # git_flow project
doppler run -- \
  cargo run -- validate-pull-request --head-ref feature/rar --base-ref main

安装

cargo install git_flow
# validate branch
git_flow validate-branch $BRANCH_NAME

需求

• 顶级目录Cargo工作空间
• 顶级目录Yarn工作空间

GitHub环境变量

• CRATES_API_KEY. 发布到crates.io的API令牌
• NPM_TOKEN. 发布到crates.com的API令牌

分支

分支必须以下列前缀之一开始

feature/

功能分支将新功能实现到我们的代码库中，并对应于之前计划的issue。

improvement/

改进分支将新功能实现到我们的代码库中，但不对应于之前计划的issue。这些是重构和安全性的开放issue。

bugfix/

修复问题解决了之前报告的错误。修复将包含在下一个次要或主要版本周期中。

hotfix/

热修复解决了之前报告的错误，并引入了需要补丁版本更新的功能。

hotfix-base/

hotfix-base分支对应于热修复，必须与之前标记的提交相关联。

release/

发布分支更新了我们的一个包的Cargo、NPM或Docker版本。

version-bump/

将发布分支合并到main后，必须合并一个version-bump分支。版本升级将包升级到下一个版本并更新Changelog。

deployment/

部署分支更新我们的基础设施以在托管服务器上运行包的新版本。部署分支只能包含部署包新版本所必需的更改，并必须更新此存储库的全球README文件。