美文网首页
Git 提交规范

Git 提交规范

作者: Cuccci | 来源:发表于2019-07-25 23:12 被阅读0次
  1. 前言
    在提交commit信息时,为了统一规范commit信息,可以在Git Hooks中编写修改commit-msg脚本来先 实现自定义commit信息校验规则

  1. git hooks 所在路径
    hooks脚本在git项目中的根目录下的.git目录,具体路径为:.git/hooks/
    目录内容如下图所示:


    图1.png

  1. 修改脚本内容
    本次为了校验commit信息是否符合提交规范,所以我们在commit-msg这个hook中编写脚本内容

    #! /usr/bin/env python
    # -*- encoding: utf-8 -*-
    import sys
    import re
    
    # 可以根据自己团队的需求来修改正则表达式
    pattern = re.compile(
    "^(feat|fix|polish|docs|style|refactor|perf|test|workflow|ci|chore|types)(\(.+\))?: .{1,50}")
    
    def validate_commit_msg(msg: str):   
        """ 
        校验git commit 内容格式是否满足要求    
        :param msg:    
        :return: void   
        """   
        if msg.startswith("Revert"):
            sys.exit(0)
        elif msg.startswith("Merge"):
            sys.exit(0)
        elif re.match(pattern, msg):
            sys.exit(0)    
        else:        
            print("invalid commit format")
            sys.exit(1)
    if __name__ == "__main__":   
        # 在commit-msg 这个hook运行时会传入一个保存commit信息的文件地址
        # 需要从这个文件中读取提交信息
        file_name = sys.argv[1]
        print(file_name)    
        commit_msg = ""   
        with open(file_name, encoding="utf-8") as file:
            for line in file.readlines():
                commit_msg += line    
        validate_commit_msg(commit_msg)
    

  1. IDEA插件
    可以在Jetbrain中安装Git Commit Template 插件配合使用


  2. 注意事项
    需要在环境变量中加入Python可执行目录,不然这个脚本会执行失败

相关文章

  • iOS 小谈一叙

    一、规范 1) git 提交规范 适当使用git merge / git rebase 2) 代码规范 注意改动别...

  • 我的git学习日志

    关于提交规范(git commit conventions) 参考文献: 你可能会忽略的 Git 提交规范Comm...

  • Git的分支命名

    主要规范两点: git 分支命名规范 git提交记录规范 一. git 分支命名规范 git分支分为集成分支、功能...

  • gitflow 规范及工具整理

    gitflow 进阶规范 git cz 通过工具 git-cz 规范 git commit 提交信息。 使用 gi...

  • git分支命名规范

    git 分支命名规范 git 分支命名规范 为规范开发,保持代码提交记录以及 git 分支结构清晰,方便后续维护,...

  • git commit 提交规范(优化)

    git commit 提交模板和规范 Git每次提交代码,都要写 Commit message(提交说明),否则就...

  • Android Studio插件--Git Commit Tem

    规范团队代码提交,Android studio 可以使用 Git Commit Template 插件对Git提交...

  • Git 分支命名规范

    Git 分支命名规范 为规范开发,保持代码提交记录以及 git 分支结构清晰,方便后续维护,现规范 git 的相关...

  • GIT相关

    git升级版本 git update-git-for-windows git 提交规范 Header Header...

  • AndroidStudio插件-Git Commit Templ

    为了规范化团队代码提交,可以使用Git Commit Template插件对git提交规范进行一定的约束,方便后期...

网友评论

      本文标题:Git 提交规范

      本文链接:https://www.haomeiwen.com/subject/aiclrctx.html