vcicd-cli

1.1.17 • Public • Published

vcicd-cli

# install
yarn global add vcicd-cli

cicd --help
----
Usage: cicd [options] [command]

Options:
  -V, --version    output the version number
  -h, --help       display help for command

Commands:
  app              为应用接入CI/CD流水线
  config           用户信息、CI/CD相关配置
  login [options]  用户登录: 初始化cicd命令行工具
  help [command]   display help for command

cicd app --help
----
Usage: cicd app [options] [command]

为应用接入CI/CD流水线

Options:
  -h, --help        display help for command

Commands:
  init [options]    🔥为应用配置CI流程, 请务必进入应用根目录,再执行此命令
  deploy [options]  🔥为应用配置CD流程, 请务必进入k8s-vela-config根目录(非master分支), 再执行此命令
  jenkins           🚫单独为应用创建Jenkins多分支流水线任务, 并添加Jenkins webhook到GitLab仓库
  hook [options]    🚫单独添加[Jenkins|GitLab机器人|CICD机器人]的webhook到GitLab仓库
  script [options]  🚫单独为应用生成CI脚本
  mr                🚀快速提交MergeRequest到k8s-vela-config仓库
  help [command]    display help for command

特别说明

  • 本项目CI流程适用场景:GitOps模式下Jenkins+Gitlab+Kubernetes搭建起来的CI环境
    • CI流程:提交代码->Gitlab通知->Jenkins打包构建镜像->钉钉群通知
  • 本项目CD流程适用场景:GitOps模式下Gitlab+Kubernetes+Kubevela搭建起来的CD环境
    • CD流程:根据项目需要修改生成的文件 -> 提交MergeRequest请求 -> 通知运维进行评审、部署

使用前,请在本地配置正确的环境变量

# 示例
# vi ~/.zshrc 
export GITLAB_URL="http://xxxx"
export GITLAB_PRIVATE_TOKEN="xxx"

# source ~/.zshrc

使用帮助

# 安装工具
brew install node
brew install yarn
yarn global add vcicd-cli
# 升级工具版本
yarn global add vcicd-cli
# 查看工具版本
cicd --version
# 登录CICD
cicd login
# 自动创建Jenkins任务、绑定Webhook、生成CI配置文件
# 进入项目根目录
cicd init
# 生成CD部署清单 (工具版本 >= 1.0.0)
# 进入k8s-vela-config根目录(非master分支)
cicd deploy

单独使用某项功能

# 自动创建Jenkins任务
# 进入项目根目录
cicd jenkins
# 为Gitlab项目绑定Webhook
# 进入项目根目录
cicd hook --gitlab --jenkins --cicd
# 生成CI配置文件
# 进入项目根目录
cicd script

Readme

Keywords

none

Package Sidebar

Install

npm i vcicd-cli

Weekly Downloads

0

Version

1.1.17

License

ISC

Unpacked Size

151 kB

Total Files

56

Last publish

Collaborators

  • miyoosan