git 配置commit-msg

_必应

已于 2022-09-01 10:12:42 修改

阅读量1.4k

点赞数

分类专栏： git 文章标签： git

于 2022-09-01 10:11:51 首次发布

本文链接：https://blog.csdn.net/jbguo/article/details/126637387

版权

git 专栏收录该内容

2 篇文章 0 订阅

订阅专栏

本文介绍了如何通过husky和commitlint来确保git commit信息中包含Jira链接，以符合公司规范。首先安装husky和commitlint，然后配置 husky 的commit-msg钩子，并编写检查脚本来验证提交信息是否包含Jira链接。当提交信息不满足条件时，脚本将返回错误信息提示缺少Jira链接。

摘要由CSDN通过智能技术生成

有些时候公司会要求git commit 强制附加jira链接，确定本次提交属于某个具体任务，提供下解决思路。
调研后决定使用husky实现，需要的插件

安装husky
安装commitlint

# 安装husky
npm install husky -D
# 设置运行脚本并运行
npm set-script prepare "husky install"
npm run prepare

# 安装commitlint 根据操作系统选一种
# Install and configure if needed
npm install --save-dev @commitlint/{cli,config-conventional}
# For Windows:
npm install --save-dev @commitlint/config-conventional @commitlint/cli

# 添加hooks及赋权
npx husky add .husky/commit-msg 'npx --no -- commitlint --edit "$1"'
chmod a+x .husky/commit-msg

# 生成commitlint.config.js
# Configure commitlint to use conventional config 
echo "module.exports = { extends: ['@commitlint/config-conventional'] };" > commitlint.config.js

附：我的.husky/commit-mgs


msg=`awk '{printf("%s",$0)}' $1`
result=$(echo $msg | grep "127.0.0.1")
if [[ "$result" != "" ]];
then
        echo -e "提交成功！"
else
        echo -e "提交失败：提交信息中必须包含jira的url"
        exit 1
fi
npx --no -- commitlint --edit "$1"

报错信息

git commit -m ‘test’ 错误信息
-e 提交失败：提交信息中必须包含jira的url

也可以通过commitlint.config.js 进行自定义配置

module.exports = {
  extends: ['@commitlint/config-conventional'],
  rules: {
    'hello-world-rule': [2, 'always'],
  },
  plugins: [
    {
      rules: {
        'hello-world-rule': ({subject}) => {
          const HELLO_WORLD = 'Hello World';
          return [
            subject.includes(HELLO_WORLD),
            `Your subject should contain ${HELLO_WORLD} message`,
          ];
        },
      },
    },
  ],
};

报错如下

⧗ input: test ✖ Your subject should contain Hello World message
[hello-world-rule]

✖ found 1 problems, 0 warnings ⓘ Get help:
https://github.com/conventional-changelog/commitlint/#what-is-commitlint