spring.profiles.active配置了没生效_一文带你彻底学会 Git Hooks 配置
你好,我是小桔,是一个没有感情的代码崽。
今天给大家介绍一下 Git Hooks,相信 Git 大家都在用吧,Git 除了用作版本控制,还有许多高级功能,Git Hooks 就是其中之一。
本文环境:
- Git 版本:2.27.0
- Husky 版本:4.2.5
- Node.js 版本:12.16.2
前言
做过前端的同学对 Hook 这个东西应该很了解吧,后端也是有 Hook 这种概念的,比如 Java 的@PostConstruct
,也是一种 Hook 的体现。简单来说,Hook 就是在执行某个事件之前或之后进行一些其他额外的操作。
举个栗子,张三现在要吃饭,那么吃饭就是一个事件,吃饭前和吃饭后就可以称为两个钩子。现在你想让张三在吃饭前洗下手,那么我们就可以在吃饭前这个钩子这里,设置一个洗手的动作。张三在每次吃饭前,都会检查一下这个钩子,有什么要做的,都会照做。这样,就实现了我们的需求。
Git 也是如此,在 Git 中也有许多的事件(commit、push 等等),每个事件也是对应了有不同的钩子的(如 commit 前,commit 后),那么我们就可以在这些钩子这里配置一些自己需要执行的操作来实现各种各样的需求。
使用
真实场景
可能初次了解 Git Hooks 的同学会有一些疑问:这个东西到底能干嘛?我以前没用过它不也一样好好的吗?我干嘛要用它?
其实这说得很对,**任何技术都是有需求采用,没有需求就别去硬塞,永远记住:技术为业务服务。**但是这并不妨碍你先去了解它,毕竟,只有你先知道了这项技术能解决什么样的问题,日后当你遇到相应的问题时,你才知道该用什么技术去解决。
这里我给出一个真实的场景,是我们团队在开发 Lin UI 的时候遇到的:
我们的 Git 仓库中包含了编译后的代码,所以每次修改了源码,都需要运行一下编译命令,然后把源码和编译后的代码一起提交到 Git 仓库,这个流程没什么问题。但是,人脑不是电脑,总会有疏忽的时候,经常会出现这样一种情况:修改了源码,却忘记了运行编译命令,最后只把源码提交到了 Git 仓库,导致线上仓库的源码和编译产物不一致、
这个问题虽然不是特别严重,但老是出现也总归不好。所以我们就想了一个办法,不再手动编译,把编译任务交给 CI 去做,这样就不存在这样的问题。
但事情总是没那么顺利,因为我们在本地开发调试的时候是需要编译代码的,所以就会生成一部分编译代码,在使用 Git 时,我们经常会使用git add .
命令,会把所有修改了的代码都提交到仓库,这显示是不行的。因为现在我们已经把编译交给 CI 去做了,并且为了 Code Review 方便,编译代码不应该再提交到仓库了。如果每次手动去把编译代码去除,又非常麻烦,那该怎么办呢?
这种情况,就可以使用 Git Hooks 帮我们在每次提交前自动把编译代码去掉了。
PS:这个场景虽然不那么常见和通用,但确实是在开发中真实遇见的。
Git Hooks 介绍
Git Hooks 的实现其实非常简单,就是就.git/hooks
文件下,保存了一些 shell 脚本,然后在对应的钩子中执行这些脚本就行了。比如下图中,这是一个还没有配置 Git Hooks 的仓库,默认会有很多.sample
结尾的文件,这些都是示例文件
我们打开pre-commit.sample
文件看一下其中的内容,大致意思是说这是一个示例,做了一些格式方面的检测,这个脚本默认是不生效的,如果要生效,把文件名改为pre-commit
即可
pre-commit
这个钩子是在git commit
命令执行之前触发
Git 支持的所有钩子见下表(加粗的为常用钩子):
PS:完整钩子说明,请参考官网链接
Husky 配置
从上面的介绍中,我们知道 Git Hook 保存在 .git 文件夹中。不知你有没有发现这会有一个问题?可能细心的同学已经知道了,Git 是一个多人协作工具,那按理说 Git 仓库中的所有文件都应该被跟踪并且上传至远程仓库的。但是有个例外,.git
文件夹不会,这就导致一个问题,我们在本地配置好 Git Hook 后,怎么分享给其他小伙伴儿呢?copy 吗?那未免太 low 了,都用 Git 了,还 copy,也太不优雅了。这时候,就轮到 Husky 出场了。
Husky 是一个让配置 Git 钩子变得更简单的工具(题外话:Husky 是哈士奇的意思,我猜可能是作者养了条二哈)
下面这些流行的项目都在使用 Husky,可见它确实是一个非常好用的工具:
- webpack
- babel
- create-react-app
- ……
Husky 的原理是让我们在项目根目录中写一个配置文件,然后在安装 Husky的时候把配置文件和 Git Hook 关联起来,这样我们就能在团队中使用 Git Hook 了。
下面开始配置 Husky
第一步
使用 npm 初始化你的项目(如果项目已有 package.json,请跳至第二步)
npm init -y
第二步
安装 Husky
// 注意 Node.js 版本要 >=10
npm install husky -D
第三步
书写配置文件,4.2.5 版本的 Husky 共支持以下几种格式的配置文件:
- .huskyrc
- .huskyrc.json
- .huskyrc.yaml
- .huskyrc.yml
- .huskyrc.js
- husky.config.js
个人习惯,这里我采用的是.huskyrc
,在其中书写 json 格式的配置,如下:
{"hooks": {"pre-commit": "git restore -W -S dist examples/dist"}
}
是不是很简单,我们来解读一下这个配置文件。hooks
这个对象中,key 就是钩子名,而 value 就是需要执行的命令。上面这个配置的含义就是,在每次执行 git commit
之前,都会把dist
和examples/dit
目录下的修改回滚(这两个目录就是编译产生的代码),就不用担心误把编译后的代码提交到仓库中了。
上面我们只写了一条命令,如果想执行两条命令怎么办呢?比如我还想在git commit
之前用 EsLint 检查一下代码质量,我们可以像下面这样写:
{"hooks": {"pre-commit": "git restore -W -S dist examples/dist && eslint ."}
}
是的,就是这么简单。如果 EsLint 检测不通过,那么git commit
是会被阻止的,就不用担心"垃圾代码"被提交到线上仓库了。
Husky 注意事项
Husky 让我们可以很方便的配置 Git Hooks,同时,也提供了一些实用方便的小技巧以及一些我们需要注意的点
不支持的钩子
Husky 不支持服务端 Git 的钩子:
- pre-receive
- update
- post-receive
跳过所有钩子
有时你可能不想运行钩子,那么可以像下面这样跳过:
HUSKY_SKIP_HOOKS=1 git rebase ...
禁用自动安装
如果你不想 Husky 为你自动安装钩子(比如 clone 了一个第三方的库,想要自己开发时),可以这样做:
HUSKY_SKIP_INSTALL=1 npm install
最后
本文介绍了 Git Hooks 具体有哪些,并讲解了如何用 Husky 便捷的配置 Git Hook。下一篇文章,我会教你如何用 commitlint 结合 Husky 来规范团队的 commit 信息,如果有兴趣的话,记得一定要关注我哦!
我是小桔,欢迎关注我的微信公众号,带你了解更多前后端知识。
spring.profiles.active配置了没生效_一文带你彻底学会 Git Hooks 配置相关推荐
- yii urlmanager配置post不生效_一文带你彻底学会 Git Hooks 配置
你好,我是小桔,是一个没有感情的代码崽. 今天给大家介绍一下 Git Hooks,相信 Git 大家都在用吧,Git 除了用作版本控制,还有许多高级功能,Git Hooks 就是其中之一. 本文环境: ...
- spring.profiles.active配置了没生效_微服务架构之「 配置中心 」
在微服务架构的系列文章中,前面已经通过文章<微服务架构之「服务网关 」>介绍过了在微服务中服务网关的原理和应用,今天这篇文章我们继续来聊一聊微服务中另外一个重要模块:「 配置中心 」.后面 ...
- SpringBoot配置文件中spring.profiles.active配置详解
SpringBoot配置文件中spring.profiles.active配置详解 1.多环境配置 我们在开发Spring Boot应用时,通常同一套程序会被应用和安装到几个不同的环境,比如:开发.测 ...
- spring.profiles.active配置解析、
1.在配置springcloud 时候.不了解spring.profiles.active 有什么作用.看看文档去了只有. > 查看官方文档: 2.1 Environment Repositor ...
- springboot启动spring.profiles.active和spring.profiles.include影响的区别
application.properties文件内容 spring.profiles.active=test4 pring.profiles.include=test3,test5 version=1 ...
- spring.profiles.include 跟 spring.profiles.active 的区别
spring.profiles.include 跟 spring.profiles.active 的区别 背景 我们经常看到springboot的 spring.profiles.active,有时也 ...
- spring.profiles.active 配置未生效
spring.profiles.active 配置未生效 先看一下我遇到的问题及配置内容 application.yml文件 #指定环境的默认配置 spring:profiles:active: pr ...
- apollo @value没生效_不问不要紧,一文要人命,绝对的面试加分项配置中心Apollo深度解读...
往期推荐 阿里面试官问我:到底知不知道什么是Eureka,这次,我没沉默 万字详解Ribbon架构,针对面试高频题多角度细说Ribbon 什么是Hystrix,阿里技术最终面,遗憾的倒在Hystrix ...
- spring.profiles.active 多种开发环境配置详解
在项目开发中,会有这样的需求,存在多种开发环境的配置,例如开发环境,预发环境,线上环境. 我们可以使用Spring的profiles机制来解决这种问题. Spring的profiles有两个变量我们可 ...
最新文章
- cookie关键字_我遇过的最难的Cookie问题
- ConfigParser
- Python 3.3.2 中文版
- AI:大力出奇迹?Bigger is better?AI下一代浪潮?—人工智能的大语言模型(LLMs)的简介、发展以及未来趋势
- Android 蓝牙开发,申请打开蓝牙
- python 弹出对话框_python+selenium 抓取弹出对话框信息
- #nginx# 泛解析大量域名的情况下 将不带www的域名,301到与之对应的www前缀的域名...
- 开关电源雷击浪涌整改_高频开关电源的EMC电磁兼容整改问题分析
- 【半年总结】---凤凰涅槃,历久弥新
- Android Studio项目目录结构介绍
- 42.Linux/Unix 系统编程手册(下) -- 共享库高级特性
- JavaScript编写计算器-《JavaScript王者归来》读书笔记1
- Ubuntu 桌面美化教程
- 密码学的基础:X.690和对应的BER CER DER编码
- pytorch求解高维空间PDE
- php代码计算三角形面积,c语言计算三角形面积代码
- python实现批量变更阿里云DNS解析记录状态
- 一个人写一个集群:基于GRPC的golang微服务框架iogo(grpc/protobuf/etcd/freetoo/码客 卢益贵)
- 8种方法突破iGuard网页防篡改软件保护
- 黑客代码雨源代码_工业城黑客空间教授的东西比代码更有价值
热门文章
- mysql 取消主从复制_MySQL:第一次看到有人把MySQL主从复制讲解的这么清楚
- CTF-攻防世界-reverse进阶-srm-50;(巨详细)
- python学习必会知识点:对文件操作详解
- Python储备知识与装饰器
- python 的String,集合(List,元组,Dict)
- 如何添加交叉编译工具链(toolchain)到环境变量?(--sysroot路径)(新:ubuntu交叉编译工具链环境变量的配置)
- 横波与纵波的本质区别是什么?——偏振
- Intel Realsense D435 是否启动pipeline.start()就开始传输帧,还是只有我们调用wait_for_frames()函数时它才会传输帧?(任务管理器USB带宽内存测试)
- CMD是什么?(命令行提示符)如何使用python在windows上操作CMD?(python执行命令行)os.syste[m](执行的命令)、os.popen(执行的命令)
- 关于Python里的super用法研究