automation-vue

TODO

commit message 规范化【GUI 工具提交如何管控？】
自动生成 CHANGELOG
集成 Jenkins Pipeline CICD

commitlint 规范提交

依赖安装

@commitlint/cli
@commitlint/config-conventional
@commitlint/parse

npm install @commitlint/config-conventional @commitlint/cli @commitlint/parse --save-dev

📢：Windows 下依赖要全局安装。避免使用 GUI 提交时 commitlint 报错。 https://commitlint.js.org/#/
npm install -g @commitlint/cli @commitlint/config-conventional

通过 gitHooks 启用 commitlint

vue-cli 创建的项目通过在 package.json 中 gitHooks 开启 commitlint。

"gitHooks": {
  "commit-msg": "commitlint -E GIT_PARAMS"
}

commit 规范参考

https://docs.google.com/document/d/1QrDFcIiPjSLDn3EL15IJygNPiHORgU1_OOAqWjiDU5Y/edit# https://www.conventionalcommits.org/en/v1.0.0/

type(scope?): subject # scope is optional; multiple scopes are supported (current delimiter options: "/", "\" and ",")

现实的例子：

chore: run tests on travis ci

fix(预算科目): 17453-预算科目参照表格高度未自适应

feat: 7605-项目预算更新

commitlint.config.js

配置 commitlint.config.js 文件用于配置 commitlint

module.exports = {
  extends: ["@commitlint/config-conventional"],
  parserPreset: {
    parserOpts: {
      // issue 前缀，自动识别 #1234 为 issue，可在 commit message 中写入关闭的问题 id
      issuePrefixes: ["#"],
    },
  },
  rules: {
    "header-max-length": [0, "always", 100],
    "type-enum": [
      2,
      "always",
      [
        "feat", // feature 新功能，新需求
        "fix", // 修复 bug
        "docs", // 仅仅修改了文档，比如README, CHANGELOG, CONTRIBUTE等等
        "style", // 仅仅修改了空格、格式缩进、逗号等等，不改变代码逻辑
        "refactor", // 代码重构，没有加新功能或者修复bug
        "test", // 测试用例，包括单元测试、集成测试等
        "revert", // 回滚到上一个版本
        "perf", // 性能优化
        "chore", // 改变构建流程、或者增加依赖库、工具等，包括打包和发布版本
        "conflict", // 解决合并过程中的冲突
      ],
    ],
  },
}

效果图

Command Line 失败场景

SourceTree 失败场景

VSCode 失败场景

standard-version

How It Works:

Follow the Conventional Commits Specification in your repository.

When you're ready to release, run standard-version.

standard-version will then do the following:

Retrieve the current version of your repository by looking at packageFiles[1], falling back to the last git tag.

bump the version in bumpFiles[1] based on your commits.

Generates a changelog based on your commits (uses conventional-changelog under the hood).

Creates a new commit including your bumpFiles[1] and updated CHANGELOG.

Creates a new tag with the new version number.

一个按照语义版本规范生成版本及变更日志的 js 插件。

语义版本

https://semver.org/lang/zh-CN/

版本格式：主版本号.次版本号.修订号，版本号递增规则如下：

主版本号：当你做了不兼容的 API 修改；
次版本号：当你做了向下兼容的功能性新增；
修订号：当你做了向下兼容的问题修正。

标准的版本号必须（MUST）采用 X.Y.Z 的格式，其中 X、Y 和 Z 为非负的整数，且禁止（MUST NOT）在数字前方补零。X 是主版本号、Y 是次版本号、而 Z 为修订号。每个元素必须（MUST）以数值来递增。例如：1.9.1 -> 1.10.0 -> 1.11.0。

先行版本号及版本编译信息可以加到“主版本号.次版本号.修订号”的后面，作为延伸。

TODO: 搞清楚 standard-version 版本号的默认变化规则

安装依赖

npm install standard-version --save-dev

添加 release 脚本命令

在 package.json 的 scripts 增加 release 脚本，用于执行 standard-version

"scripts": {
  "release": "standard-version"
}

默认情况下会把 commit 中 type 为 feat 的记录生成需求 log，fix 生成 bug 修复。如下图所示：

常用命令

https://github.com/conventional-changelog/standard-version

npm run release -- --dry-run 用于调试，该命令不会真正执行发布动作只会打印执行动作信息。
npm run release 发版
- --first-release 第一次发版
- --release-as 指定版本 eg: npm run release -- --release-as 1.0.0.0301.00
  - major 主版本
  - minor 次版本
  - patch 修订号
- --prerelease [name] 预发版本 eg: npm run release -- --prerelease alpha
- --dry-run 试运行，打印出要执行的命令，不会提交代码。
- --no-verify 不触发 gitHooks
- --help 帮助

自定义配置

standard-verion 可以通过 .versionrc .versionrc.json .versionrc.js 文件进行自定义配置。具体配置信息 👉 conventional-changelog-config-spec

.versionrc.json

{
  "header": "变更日志",
  "bumpFiles": [
    { "filename": "./src/apps/ebs/manifest.json","type": "json"}, // 用于指定版本元数据文件路径，standard-verion 将修改该文件中的版本信息
    { "filename": "./package.json","type": "json"}
  ],
  "types": [
    { "type": "feat", "section": "✨ Features | 新功能" },
    { "type": "fix",  "section": "🐛 Bug Fixes | 修复缺陷"},
    { "type": "chore", "hidden": true },
    { "type": "docs",  "hidden": true },
    { "type": "style", "hidden": true },
    { "type": "refactor", "hidden": true, "section": "🪄 重构代码。不包括 bug 修复、功能新增"  },
    { "type": "perf","hidden": true,"section": "🚀 性能优化"  },
    { "type": "test", "hidden": true }
  ]
}

commit url 默认取 package.json 中 repository.url

"repository": {
  "type": "git",
  "url": "git+https://github.com/joyran/yi-blog.git"
}

自定义 updaters

其它

manifest.json

{
  "app": {
    "name": "expense-budget-service",
    "version": "hotfix-ebs-supplement-contract-2",
    "description": "费用预算管理",
    "build": {
      "timestamp": "2022-02-16 14:07:15"
    }
  },
  "git": {
    "branch": "hotfix-0001",
    "commit": {
      "id": "333ff6d",
      "time": "2022-02-16 14:06:31"
    }
  }
}

JL-Code / automation-vue