Python - Git仓库忽略提交规则 & .gitignore配置

Git 忽略文件提交的方法

有三种方法可以实现忽略Git中不想提交的文件。

在Git项目中定义 .gitignore 文件

这种方式通过在项目的某个文件夹下定义  .gitignore 文件，在该文件中定义相应的忽略规则，来管理当前文件夹下的文件的Git提交行为。

 .gitignore 文件是可以提交到公有仓库中，这就为该项目下的所有开发者都共享一套定义好的忽略规则。

在  .gitingore  文件中，遵循相应的语法，在每一行指定一个忽略规则。如：

• *.log
• *.temp
• /vendor2\

 

在Git项目的设置中指定排除文件

这种方式只是临时指定该项目的行为，需要编辑当前项目下的  .git/info/exclude  文件，然后将需要忽略提交的文件写入其中。

需要注意的是，这种方式指定的忽略文件的根目录是项目根目录。

 

定义Git全局的 .gitignore 文件

除了可以在项目中定义 .gitignore 文件外，还可以设置全局的 git .gitignore 文件来管理所有Git项目的行为。这种方式在不同的项目开发者之间是不共享的，是属于项目之上Git应用级别的行为。

这种方式也需要创建相应的 .gitignore 文件，可以放在任意位置。然后在使用以下命令配置Git： git config --global core.excludesfile ~/.gitignore 

 

.gitignore文件中的忽略规则

在 .gitignore 文件中，每一行的忽略规则的语法如下：

空格不匹配任意文件，可作为分隔符，可用反斜杠转义

#开头：标识注释，可以使用反斜杠进行转义

! 开头：标识否定，该文件将会再次被包含，如果排除了该文件的父级目录，则使用 ! 也不会再次被包含。可以使用反斜杠进行转义

/ 结束：只匹配文件夹以及在该文件夹路径下的内容，但是不匹配该文件

/ 开头：匹配文件

如果一个模式不包含斜杠，则它匹配相对于当前 .gitignore 文件路径的内容，如果该模式不在 .gitignore 文件中，则相对于项目根目录

** 匹配多级目录，可在开始，中间，结束

? 通用匹配单个字符

[] 通用匹配单个字符列表

 

常用匹配示例：

bin/ ：忽略当前路径下的bin文件夹，该文件夹下的所有内容都会被忽略，不忽略 bin 文件

/bin ：忽略根目录下的bin文件

/*.c ：忽略 cat.c，不忽略 build/cat.c

debug/*.obj ： 忽略 debug/io.obj，不忽略 debug/common/io.obj 和 tools/debug/io.obj

**/foo ： 忽略/foo, a/foo, a/b/foo等

a/**/b ： 忽略a/b, a/x/b, a/x/y/b等

!/bin/run.sh ： 不忽略 bin 目录下的 run.sh 文件

*.log ： 忽略所有 .log 文件

config.php ： 忽略当前路径的 config.php 文件

 

.gitignore规则不生效

.gitignore只能忽略那些原来没有被 track 的文件，如果某些文件已经被纳入了版本管理中，则修改.gitignore是无效的。

解决方法就是先把本地缓存删除（改变成未track状态），然后再提交:

git rm -r --cached .
git add .
git commit -m 'update .gitignore'

 

.gitignore配置文件

# Byte-compiled / optimized / DLL files
__pycache__/
*.py[cod]
*$py.class

# C extensions
*.so

# Distribution / packaging
.Python
build/
develop-eggs/
dist/
downloads/
eggs/
.eggs/
lib/
lib64/
parts/
sdist/
var/
wheels/
*.egg-info/
.installed.cfg
*.egg
MANIFEST

# PyInstaller
#  Usually these files are written by a python script from a template
#  before PyInstaller builds the exe, so as to inject date/other infos into it.
*.manifest
*.spec

# Installer logs
pip-log.txt
pip-delete-this-directory.txt

# Unit test / coverage reports
htmlcov/
.tox/
.coverage
.coverage.*
.cache
nosetests.xml
coverage.xml
*.cover
.hypothesis/
.pytest_cache/

# Translations
*.mo
*.pot

# Django stuff:
*.log
local_settings.py
db.sqlite3

# Flask stuff:
instance/
.webassets-cache

# Scrapy stuff:
.scrapy

# Sphinx documentation
docs/_build/

# PyBuilder
target/

# Jupyter Notebook
.ipynb_checkpoints

# pyenv
.python-version

# celery beat schedule file
celerybeat-schedule

# SageMath parsed files
*.sage.py

# Environments
.env
.venv
env/
venv/
ENV/
env.bak/
venv.bak/

# Spyder project settings
.spyderproject
.spyproject

# Rope project settings
.ropeproject

# mkdocs documentation
/site

# mypy
.mypy_cache/

# add
.idea/