@johnhom/mg-cli
v3.1.0
Published
CLI to auto merge branch to target branch which is provided
Downloads
2
Readme
mg-cli
🚀 (Auto) Merge CLI
Auto Merge CLI 是一个功能强大的命令行工具,旨在帮助开发者自动拉取代码、合并分支、推送远程等等操作。
它提供了一种简单而高效的方式,通过shelljs库调用Node.js API,实现在shell中执行git相关的操作,无需人工一步步去操作git进行分支的切换和合并,以提高工作的效率。
👀 使用示例
背景:假设你完成了功能分支feature/a
的开发,想要合并到测试分支dev
,并且推到远程。
一般我们的操作步骤是:
# 切换到 dev 分支
git checkout dev
# 下拉 dev 分支的远程代码
git pull
# 合并功能分支 feature/a 到 dev
git merge feature/a
# 推送 dev 分支到远程仓库
git push
以下是使用Auto Merge CLI的简单示例命令:
# 处于 feature/a 分支中
amg dev
上述会按顺序进行如下操作:
- 在当前分支执行
git pull
- 获取当前分支的名称
- 切换到目标分支
dev
- 执行
git pull
- 合并分支
- 询问是否要推到远程
- 询问是否要切回源分支
使用的示例图片如下:
⌛️ 安装
全局安装
npm install -g @johnhom/mg-cli
# 或者
# yarn global add @johnhom/mg-cli
💡 具体用法
Usage:
$ amg [target_branch]
Commands:
[target_branch] merge current branch into target_branch
For more info, run any command with the `--help` flag:
$ amg --help
Options:
-h, --help Display this message
-v, --version Display version number
Examples:
amg master 把当前分支自动合并到master
假设你当前项目所在的分支为:feature/a
,你想要把这个分支合并到dev
,并自动上传到远程仓库,你只需要执行以下命令:
amg dev
⏳ 调试方式
使用pnpm link对当前项目链接到电脑的全局环境上,如果是在项目的根目录,则执行以下命令:
注意:如果你的电脑已全局安装
@johnhom/mg-cli
,则需要先删除全局包,再link
pnpm link --global --dir=./packages/mg-cli