使用 commitizen 优化 git 提交

之前写了一篇博客,用来做备忘,每次有新项目的时候,就上去复制粘贴:

关于项目 git 协作流程的思考

但是因为有一些思考过程,所以不太方便施展 C+V 大法,现在汇总一下。

一、安装依赖

yarn add -D commitizen \
  cz-conventional-changelog \
  @commitlint/config-conventional \
  @commitlint/cli \
  husky \
  standard-version

二、添加配置文件

在项目根目录下,添加 .commitlintrc.js 文件。

.commitlintrc.js

内容如下:

module.exports = {
  extends: [
    '@commitlint/config-conventional'
  ],
  rules: {
  }
};

三、修改 package.json 文件

// 修改 scripts 部分
scripts: {
    "commit": "git-cz",
    "release": "standard-version"
}

// 修改或添加 config 字段
"config": {
    "commitizen": {
        "path": "node_modules/cz-conventional-changelog"
    }
}

// 修改或添加 kusky 字段
"husky": {
    "hooks": {
      "commit-msg": "commitlint -e $GIT_PARAMS"
    }
  },

四、总结

这个时候,运行 yarn commit 命令就可以提交代码.

1. 自动 release

运行 yarn release 命令就可以用来自动更新 package.json 中的 version 字段,生成或更新 CHANGELOG.md 文件,以及触发一次 release 提交并打上相应的 git tag

2. 修改 CHANGELOG.md 生成规则

如果想对生成的 CHANGELOG.md 自定义规则的话,可以参考:Conventional Changelog Configuration Spec (v2.1.0)

3. 第一次 release

第一次调用 yarn release 命令的话,加上 --first-release 参数,这样就不会自动修改当前 package.json 的版本号了。

4. 手动指定版本号

需要手动指定版本号的话,使用 --release-as <版本号> 参数。

5. 指定 git tag 的前缀

standard version 默认会在版本号之前加上 v 的前缀。

比如执行 standard version --release-as 1.1.0 命令,会发现分支被打上了 v1.1.0 标签。

如果想要指定前缀的话,可以使用 -t [前缀] 参数。

If you do not want to have any tag prefix you can use the -t flag without value.

官网上说的是如果不希望加前缀的话,-t 参数的值不给就行,但是我直接测试了一下,如果 -t 的值不给的话,还是加上的 v 前缀,必须得指定为空字符串 '' 才行。

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 211,884评论 6 492
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 90,347评论 3 385
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 157,435评论 0 348
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 56,509评论 1 284
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 65,611评论 6 386
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 49,837评论 1 290
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 38,987评论 3 408
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 37,730评论 0 267
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 44,194评论 1 303
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 36,525评论 2 327
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 38,664评论 1 340
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 34,334评论 4 330
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 39,944评论 3 313
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 30,764评论 0 21
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,997评论 1 266
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 46,389评论 2 360
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 43,554评论 2 349

推荐阅读更多精彩内容