首页
学习
活动
专区
工具
TVP
发布
精选内容/技术社群/优惠产品,尽在小程序
立即前往

如何创建一个检查提交消息的git预提交钩子?

创建一个检查提交消息的git预提交钩子可以通过以下步骤完成:

  1. 打开项目的.git目录,进入hooks文件夹。如果该文件夹下没有pre-commit文件,则创建一个新文件并命名为pre-commit。
  2. 使用文本编辑器打开pre-commit文件,并添加以下内容:
代码语言:txt
复制
#!/bin/sh

commit_msg_file=$1
commit_msg=$(cat $commit_msg_file)

# 检查提交消息的格式是否符合要求
if ! echo "$commit_msg" | grep -qE "^[A-Z]{2,}-[0-9]{1,}: .+"; then
    echo "提交消息格式不正确,请按照\"JIRA编号: 提交描述\"的格式编写提交消息。"
    exit 1
fi

# 检查提交消息是否包含敏感词汇
if echo "$commit_msg" | grep -qiE "敏感词1|敏感词2|敏感词3"; then
    echo "提交消息包含敏感词汇,请修改后再次提交。"
    exit 1
fi

exit 0

上述脚本中,首先获取提交消息的文件路径和内容。然后,使用正则表达式检查提交消息的格式是否符合要求,要求格式为"JIRA编号: 提交描述"。如果格式不正确,则输出错误信息并终止提交。接下来,使用正则表达式检查提交消息是否包含敏感词汇,如果包含,则输出错误信息并终止提交。最后,如果一切正常,则退出脚本。

  1. 保存并关闭pre-commit文件。
  2. 在终端中,进入项目的根目录,并给pre-commit文件添加执行权限:
代码语言:txt
复制
chmod +x .git/hooks/pre-commit

现在,每次执行git commit命令时,都会触发pre-commit钩子脚本,检查提交消息的格式和内容。如果检查失败,则会阻止提交。

注意:以上脚本只是一个简单的示例,你可以根据实际需求进行修改和扩展。

页面内容是否对你有帮助?
有帮助
没帮助

相关·内容

40分15秒

APP和小程序实战开发 | APICloud 3.0介绍和开发工具上手(一)

领券