文章目录
如何配置.gitignore文件
在使用Git的时候,我们总会遇到不想要提交的文件或者文件夹,这时我们便可以通过配置.gitignore
文件来让Git忽略我们项目中相应的文件或者文件夹。
我们不需要从头开始写.gitignore
文件,因为GitHub已经为我们准备了各种配置文件(GitHub的.gitignore配置文件),我们只需要按照自己的需求更改一下就可以使用了。
注意:.gitignore
文件的位置应该位于项目的根路径下面!!!(当然可以有多个.gitignore
文件,效果如下所示)
myproject <- Git仓库根目录
├── .gitigore <- 针对整个仓库生效的.gitignore
├── LICENSE
├── README.md
├── docs
│ └── .gitigore <- 仅针对docs目录生效的.gitignore
└── source
1..gitignore
语法
以"#"号开头表示注释;
/ 以斜杠"/"开头表示目录;
* 以星号"*"通配多个字符;
? 以问号"?"通配单个字符
[] 以方括号"[]"包含单个字符的匹配列表;
! 以叹号"!"表示不忽略(跟踪)匹配到的文件或目录;
注意:Git 对于 .gitignore
配置文件的处理是按照顺序进行的,即从上到下逐行匹配规则。这意味着如果前面的规则可以匹配到某个文件,后面的规则将不会再被考虑。因此,确保将更具体的规则放在文件的前面可以确保它们被正确地应用。
示例:
plaintext
*.txt # 过滤所有以 .txt 结尾的文件
*.xml # 过滤所有以 .xml 结尾的文件
target/ # 过滤名为 target 的文件夹下的所有文件
/test/a.txt # 过滤指定目录下的具体文件 /test/a.txt
!*.py # 不过滤以 .py 结尾的文件
!/dir/test/ # 不过滤根目录下的 dir/test 目录
*.[ab] # 过滤所有以 .a 或 .b 结尾的文件
/test # 仅忽略根目录下的 test 文件夹,不包括子目录 child/test
test/ # 忽略文件夹 test 下的全部内容,不管是根目录下的/test/,还是某个子目录下的test文件夹,比如:/child/test,都会被忽略
.gitignore
文件在线生成工具:Gitignore Online Generator
2.创建.gitignore
文件所遵循的原则
当创建 .gitignore
文件时,遵循以下几个原则:
- 忽略操作系统自动生成的文件,如缩略图等。
plaintext
# 忽略操作系统自动生成的文件
Thumbs.db
ehthumbs.db
Desktop.ini
- 忽略编译生成的中间文件、可执行文件 。如果一个文件是通过另一个文件自动生成的,那自动生成的文件就没必要放进版本库。比如Java编译产生的
.class
文件。
plaintext
# 忽略编译生成的文件
*.class
*.exe
*.dll
*.py[cod]
*.so
*.egg
*.egg-info
dist
build
- 忽略带有敏感信息的配置文件,比如存放口令的配置文件。
plaintext
# 忽略带有敏感信息的配置文件
config.ini
credentials.json
deploy_key_rsa
通过遵循这些原则,可以确保 .gitignore
文件仅包含项目中不需要跟踪的文件或目录,从而保持版本库的整洁和安全。
参考
😃😃😃