git 规范化提交代码结合tag自动生成log日志

最新推荐文章于 2023-03-23 23:20:24 发布

原创最新推荐文章于 2023-03-23 23:20:24 发布 · 1.6k 阅读

1 ·

CC 4.0 BY-SA版权

笔记专栏收录该内容

8 篇文章

订阅专栏

git 规范化提交代码结合tag自动生成log日志

git commit 信息提交规范含义

feat : 新功能
fix : 修复bug
docs : 文档改变
style : 样式改变-不影响代码含义的更改（空白、格式、缺少分号）
refactor : 重构-不修复bug也不添加特性的代码更改
perf : 重构-性能优化
test : 增加确实的测试
revert : 撤销上一次的 commit
chore : 构建过程或辅助工具的变动

格式是前缀+冒号+空格

git提交生成log日志

借用工具

提交信息格式遵循commitlint提供的配置
提交信息格式插件 vsc-commitizen
全局npm安装 conventional-changelog-cli，生成日志

npm包

"husky": "^3.1.0",
"@commitlint/cli": "^8.2.0",
"@commitlint/config-conventional": "^8.2.0",

项目配置——对提交进行校验

 "husky": {
        "hooks": {
            "pre-commit": "lint-staged",// eslint提交校验
            "commit-msg": "commitlint -e $GIT_PARAMS" // 检查是否符合提交信息格式，符合提交成功
        }
    },
    "lint-staged": {
        "**/*.{js,jsx}": [
            "eslint --fix --ext .jsx,.js src",
            "git add"
        ]
    },

git 打tag

 git tag　　//查看tag
 git tag v0.3.0 c809ddbf83939a89659e51dc2a5fe183af384233　　　　//在某个commit 上打tag
 git push origin v0.3.0　　　//!!!本地tag推送到线上
 git tag -d v0.3.0　　　　　　　　//本地删除tag
 git push origin :refs/tags/v0.3.0　　　　//本地tag删除了，再执行该句，删除线上tag

tag需以（例:v0.3.0）打tag，不然最后日志识别不了

在当前项目目录下，打开控制台 
conventional-changelog -p angular -i CHANGELOG.md -s -r 0

生成的日志，每一个tag的日志是从当前commit到上一个commit之间的内容。