Gitmars

Appearance

参数设置 ​

master ​

master 分支实际名称

  • 类型：String
  • 默认：master
  • 必填：是

develop ​

develop 分支实际名称

  • 类型：String
  • 默认：dev
  • 必填：是

release ​

release 分支实际名称

  • 类型：String
  • 默认：release
  • 必填：是

bugfix ​

bugfix 分支实际名称

  • 类型：String
  • 默认：bug
  • 必填：是

support ​

support 分支实际名称

  • 类型：String
  • 默认：support
  • 必填：是

user ​

用户名称

  • 类型：String
  • 默认：``
  • 必填：否

email ​

用户邮箱

  • 类型：String
  • 默认：``
  • 必填：否

nameValidator ​

v2.9.4 新增

校验分支命名规范的正则表达式，可输入字符串或者正则

  • 类型：String,RegExp
  • 默认：``
  • 必填：否
  • 示例：
  1. 设置正则字符串
json
{
  "nameValidator": "[a-z]{3,}_w+" // 检验：saqqdy_xxxxxx
}
  1. 设置正则
js
{
    nameValidator: /[a-z]{3,}_\w+/, // 检验：saqqdy_xxxxxx
}

descriptionValidator ​

v2.11.0 新增

校验本次提交的原因描述，可输入字符串或者正则，如果不需要校验，请保持参数为：''

  • 类型：String,RegExp
  • 默认：``
  • 必填：否
  • 示例：
  1. 设置正则字符串
json
{
  "descriptionValidator": "【修改原因】.+【修改内容】.+" // 检验：【修改原因】10010某个功能有BUG【修改内容】改了某个方法
}
  1. 设置正则
js
{
    descriptionValidator: /【修改原因】.+【修改内容】.+/, // 检验：【修改原因】10010某个功能有BUG【修改内容】改了某个方法
}

msgTemplate ​

推送消息模板

  • 类型：String
  • 默认：${message}；项目：${project}；路径：${pwd}
  • 必填：否

msgUrl ​

4.0.0 弃用，消息发送地址统一使用 buildConfig 里面的地址

推送消息 API 地址

  • 类型：String
  • 默认：``
  • 必填：否

apolloConfig ​

apollo 配置参数

  • 类型：Object
  • 默认：``
  • 必填：否
  • 参数：
json
{
  "configServerUrl": "",
  "appId": "",
  "clusterName": "default",
  "namespaceName": ["namespaceName"],
  "apolloEnv": "",
  "token": ""
}

apollo 构建项目配置参考

json
{
  "username": "jenkins_username",
  "password": "jenkins_password",
  "miniprogramDomain": "miniprogram domain",
  "miniprogramToken": "miniprogram token",
  "miniprogramSession": "sessionID",
  "template": "http://www.jenkins.com/view/${line}/job/${project}/build?token=${token}", // 不带参数
  "templateWithParam": "http://www.jenkins.com/view/${line}/job/${project}/buildWithParameters?token=${token}&build_app=${app}", // 带参数
  "gitNotificationGroupUrl": "https://www.dingding.com/robot/webhook/send?type=0&token=xxxxxxxx", // 推送群消息的api
  "dev": {
    "line": "git_dev",
    "token": "dev_token",
    "list": [
      {
        "name": "project1",
        "project": "git_project1",
        "token": "" // 这个token的优先级比上一层的token高
      },
      {
        "name": "project2",
        "project": "git_project2",
        "apps": ["all", "admin", "client"],
        "miniprogram": [{ "id": "id", "name": "小程序" }]
      }
    ]
  },
  "bug": {
    "line": "git_bug",
    "token": "bug_token",
    "list": [
      {
        "name": "project1",
        "project": "git_project1_bug"
      },
      {
        "name": "project2",
        "project": "egg_project2_bug",
        "apps": ["all", "admin", "client"],
        "miniprogram": [{ "id": "id", "name": "小程序" }]
      }
    ]
  },
  "prod": {
    "line": "git_prod",
    "token": "prod_token",
    "list": [
      {
        "name": "project1",
        "project": "git_project1_prod"
      },
      {
        "name": "project2",
        "project": "git_project2_prod",
        "apps": ["all", "admin", "client"],
        "miniprogram": [{ "id": "id", "name": "小程序" }]
      }
    ]
  }
}

hooks ​

钩子配置

1.4.0 新增

  • 类型：Object
  • 默认：``
  • 必填：否
  • 示例：
json
{
  "pre-commit": "lint-staged",
  "pre-push": "gitm permission",
  "commit-msg": "commitlint -E HUSKY_GIT_PARAMS"
}

apis ​

接口配置，buildConfig用于获取构建配置，优先级高于apolloConfig；userInfo用于获取用户权限信息，替代api

2.18.0 新增

  • 类型：Object
  • 默认：``
  • 必填：是
  • 示例：
json
{
  "buildConfig": {
    "url": "https://xxx.com/xxx/getBuildConfig",
    "method": "get",
    "params": {
      "name": "gitmars"
    }
  },
  "userInfo": {
    "url": "https://xxx.com/xxx/getUserInfo"
  }
}

api ​

请求权限的 api 接口地址，需要支持的接收参数形式：url?name=git_user_name

2.0.1 新增
2.17.0 新增level=3审核员，审核员有合并权限可以执行admin publish动作，但是与管理员不同的是审核员提交代码会推送到远程。原开发者调整为 4
2.19.0 版本开始移除这项配置，由apis.userInfo替代 6.0.0 版本开始token从git config里面取user.token，接口不需要再返回token

  • 类型：String
  • 默认：``
  • 必填：否
  • 说明：

返回的参数必须包含 level，可选返回 nickname

json
{
  "level": 4, // 1=超级管理员 2=管理员 3=审核员 4=开发者
  "nickname": ""
}

gitHost ​

git 服务器位置，例如：https://gitlab.com

2.0.1 新增

  • 类型：String
  • 默认：``
  • 必填：是

gitID ​

git 项目 ID，在 gitlab 上可以查到，通常是一串数字

2.0.1 新增

  • 类型：Number
  • 默认：``
  • 必填：是

versionControlType ​

版本控制类型，如果希望强制更新所有新版本，传入patch，如果不需要控制，传入 false

5.0.0 新增

  • 类型：'major' | 'minor' | 'patch'
  • 默认：minor
  • 必填：否