.gitignore文件说明

了解如何使用.gitignore文件高效管理Git项目中的文件版本控制,掌握常见规则及创建方法。

一、简绍
我们做的每个Git项目中都需要一个“.gitignore”文件,这个文件的作用就是告诉Git哪些文件不需要添加到版本管理中。比如我们项目中的npm包(node_modules),它在我们项目中是很重要的,但是它占的内存也是很大的,所以一般我们用Git管理的时候是不需要添加npm包的。

二、常用的规则

/mtk/ 过滤整个文件夹
	*.zip 过滤所有.zip文件
	/mtk/do.c 过滤某个具体文件

以上规则意思是:被过滤掉的文件就不会出现在你的GitHub库中了,当然本地库中还有,只是push的时候不会上传。
除了以上规则,它还可以指定要将哪些文件添加到版本管理中。

!src/   不过滤该文件夹
!*.zip   不过滤所有.zip文件
!/mtk/do.c 不过滤该文件

1、配置语法:
以斜杠/开头表示目录;
以星号*通配多个字符;
以问号?通配单个字符
以方括号[]包含单个字符的匹配列表;
以叹号!表示不忽略(跟踪)匹配到的文件或目录;

此外,git 对于 .ignore 配置文件是按行从上到下进行规则匹配的,意味着如果前面的规则匹配的范围更大,则后面的规则将不会生效;

2、示例说明
a、规则:fd1/*
说明:忽略目录 fd1 下的全部内容;注意,不管是根目录下的 /fd1/ 目录,还是某个子目录 /child/fd1/ 目录,都会被忽略;
b、规则:/fd1/*
说明:忽略根目录下的 /fd1/ 目录的全部内容;
c、规则:

/*
!.gitignore
!/fw/bin/
!/fw/sf/

说明:忽略全部内容,但是不忽略 .gitignore 文件、根目录下的 /fw/bin/ 和 /fw/sf/ 目录;

3、创建.gitignore文件

  1. 常规的windows操作

根目录下创建gitignore.txt;
编辑gitignore.txt,写下你的规则,例如加上node_modules/;
打开命令行窗口,切换到根目录(可以直接在文件夹上面的地址栏输入cmd回车);
执行命令ren gitignore.txt .gitignore。
2) 用Git Bash

根目录下右键选择“Git Bash Here”进入bash命令窗口;
输入vim .gitignore或touch .gitignore命令,打开文件(没有文件会自动创建);
按i键切换到编辑状态,输入规则,例如node_modules/,然后按Esc键退出编辑,输入:wq保存退出。
如图:

dependencies npm包文件

/node_modules

production 打包文件

/build

misc

.DS_Store

npm-debug.log*
.DS_Store:这个文件是Mac OS X用来存储文件夹的一些诸如自定义图标,ICON位置尺寸,窗口位置,显示列表种类以及一些像窗体自定义背景样式,颜色这样的元信息。默认情况下,Mac OS X下的每个文件夹下应该都会生成一个,包括网络介质存储盘和U盘这样的外部设备。
image.png

npm-debug.log:项目主目录下总是会出现这个文件,而且不止一个,原因是npm i 的时候,如果报错,就会增加一个此文件来显示报错信息,npm install的时候则不会出现。
最后需要强调的一点是,如果你不慎在创建.gitignore文件之前就push了项目,那么即使你在.gitignore文件中写入新的过滤规则,这些规则也不会起作用,Git仍然会对所有文件进行版本管理。
简单来说,出现这种问题的原因就是Git已经开始管理这些文件了,所以你无法再通过过滤规则过滤它们。因此一定要养成在项目开始就创建.gitignore文件的习惯,否则一旦push,处理起来会非常麻烦。

23人点赞
自树一帜

参考:
作者:秉持本心
链接:https://www.jianshu.com/p/699ed86028c2
来源:简书

<think> 我们面临的问题:在未创建.gitignore文件的情况下,添加README文件并将其加入忽略列表,以防止版本回退更改。 根据之前的讨论,我们知道.gitignore只能忽略未跟踪文件。对于已经添加到版本库的文件(如README.md),即使将其加入.gitignoreGit仍然会跟踪其修改。 因此,我们需要执行以下步骤: 1. 如果README.md已经提交到版本库,我们需要将其从版本库中移除(但保留在工作区)。 2. 创建.gitignore文件,并在其中添加README.md,这样Git就会忽略该文件。 3. 提交.gitignore文件。 但是,用户提到“未创建.gitignore文件”,所以我们从零开始。 步骤: 1. 如果README.md已经被跟踪(即已经执行了`git add`或`git commit`),则需要先将其从索引中移除(但保留工作区文件): `git rm --cached README.md` 2. 创建.gitignore文件,并将README.md添加到.gitignore中。 3..gitignore文件添加到版本库并提交。 注意:这样操作后,README.md文件将不再被版本控制,因此不会在版本回退时被更改。但是,这个文件也不会出现在远程仓库中(因为被忽略了),所以其他开发者将看不到这个文件。 如果README.md还没有被添加到版本库(即还没有执行`git add`或`git commit`),那么直接创建.gitignore文件并添加README.md即可。 具体步骤: 情况一:README.md已经被添加到版本库(即已经被跟踪) 步骤1: 从版本库中移除README.md(保留工作区文件git rm --cached README.md 步骤2: 创建.gitignore文件,并写入忽略规则 echo "README.md" > .gitignore (注意:如果已有.gitignore文件,则使用>>追加) 步骤3: 将.gitignore添加到版本库并提交 git add .gitignore git commit -m "Stop tracking README.md and add .gitignore" 情况二:README.md尚未被添加到版本库(未跟踪状态) 步骤1: 创建.gitignore文件,并写入忽略规则 echo "README.md" > .gitignore 步骤2: 此时README.md已经被忽略,不会出现在未跟踪文件中。然后我们将.gitignore添加到版本库: git add .gitignore git commit -m "Add .gitignore to ignore README.md" 注意:在情况二中,由于README.md从未被添加到版本库,所以它一直处于未跟踪状态,并且被.gitignore忽略,因此不会出现在`git status`中。 但是,用户要求“防止版本回退更改”,这意味着我们不想让README.md被版本控制所影响。通过以上操作,README.md将不再被版本控制,因此版本回退不会影响它。 然而,请注意:如果README.md是一个重要的项目文档,通常不建议将其忽略,因为它不会出现在远程仓库中,其他协作者将无法看到。所以,这种方法更适合于本地配置文件,而不是需要共享的文档。 另外,如果希望README.md存在于远程仓库中(初始版本),但之后忽略它的修改,那么我们可以: 1. 先提交一次README.md(初始版本)。 2. 然后执行`git rm --cached README.md`,将其从版本库移除并添加到.gitignore。 3. 这样,远程仓库会保留初始版本的README.md,但之后的修改不会被跟踪。 但是,这样做的后果是:当其他开发者克隆仓库时,他们会得到初始版本的README.md,但之后他们在本地的修改也不会被跟踪。而且,如果你希望更新远程仓库的README.md,这种方法就不行了。 因此,根据需求,如果只是不想让本地的README.md被版本控制影响(比如这是一个本地化的配置文件,但恰好命名为README.md),那么忽略它是合适的。如果它是项目共享文档,则不应该忽略。 根据用户要求,我们按照忽略README.md的修改来操作。 操作步骤(假设README.md已经被跟踪): 1. 从索引中移除README.md:`git rm --cached README.md` 2. 创建.gitignore文件(如果不存在):`echo "README.md" > .gitignore` 3..gitignore加入版本控制:`git add .gitignore` 4. 提交:`git commit -m "Ignore README.md"` 操作步骤(如果README.md尚未被跟踪): 1. 创建.gitignore文件:`echo "README.md" > .gitignore` 2. 添加.gitignore到版本控制:`git add .gitignore` 3. 提交:`git commit -m "Add .gitignore to ignore README.md"` 注意:在第二种情况下,README.md不会被添加到版本库,所以它不会被提交,也不会出现在远程仓库。 如果希望README.md的初始版本存在于远程仓库中,但后续修改被忽略,可以这样做: 1. 先创建README.md并写入内容。 2. 提交README.md:`git add README.md && git commit -m "Add initial README"` 3. 然后执行:`git rm --cached README.md` 4. 创建.gitignore:`echo "README.md" >> .gitignore` 5. 提交.gitignore:`git add .gitignore && git commit -m "Ignore future changes to README.md"` 这样,远程仓库会有README.md的初始内容,但之后的修改不会被跟踪。但是,如果之后你修改了README.md,这些修改不会被提交到仓库,其他开发者也不会看到。所以这种方法适用于固定不变的README.md(但实际上,README.md通常需要更新,所以不推荐)。 鉴于用户要求是“防止版本回退更改”,也就是说,用户希望README.md不被版本回退影响。那么,我们采用忽略它的方式,这样版本回退就不会更改它(因为它不在版本控制中了)。 总结步骤(假设已经存在README.md并且已经被跟踪): 1. 将README.md从暂存区移除(保留工作区文件):`git rm --cached README.md` 2. 创建.gitignore文件(如果不存在)并添加规则:`echo "README.md" >> .gitignore` 3..gitignore文件加入暂存区:`git add .gitignore` 4. 提交:`git commit -m "Ignore README.md"` 这样,后续对README.md的修改都不会被跟踪,版本回退也不会影响它。 注意:如果还没有初始化仓库,需要先`git init`。 下面按照用户需求,给出从零开始的完整步骤(假设项目目录已经存在,且包含README.md文件,但未初始化Git仓库): 1. 初始化Git仓库:`git init` 2. 此时README.md是未跟踪状态。如果不想让它被跟踪,则创建.gitignore文件并忽略它。 3. 创建.gitignore:`echo "README.md" > .gitignore` 4. 添加.gitignore到暂存区:`git add .gitignore` 5. 提交:`git commit -m "Initial commit with .gitignore"` 这样,README.md就不会被跟踪了。 如果已经初始化了仓库,并且README.md已经被`git add`了(在暂存区)但还没有提交: 1. 从暂存区移除:`git rm --cached README.md` 2. 创建.gitignore:`echo "README.md" > .gitignore` 3. 添加.gitignore:`git add .gitignore` 4. 提交:`git commit -m "Initial commit with .gitignore"` 如果已经提交了README.md: 1. 执行:`git rm --cached README.md` 2. 创建.gitignore:`echo "README.md" >> .gitignore` (如果.gitignore已存在,则用追加方式) 3. 添加.gitignore:`git add .gitignore` 4. 提交:`git commit -m "Stop tracking README.md"` 注意:`git rm --cached`会从索引中删除文件,但保留工作目录中的文件。所以,执行后工作区的README.md还在。 最后,如果之前已经提交过README.md,那么执行`git rm --cached`并提交后,远程仓库中的README.md会被删除(因为这次提交删除了它)。如果希望保留远程仓库中的初始README.md,但之后忽略修改,那么需要按照之前提到的先提交初始版本,然后忽略后续修改。但是这样后续修改不会被提交,所以远程仓库的README.md也不会更新。所以请根据实际需求选择。 由于用户要求防止版本回退更改,所以我们选择完全忽略它(即不跟踪,也不出现在远程仓库)。这样,本地的README.md就不会被版本控制影响。 因此,我们给出以下步骤(假设已经在本地创建了README.md,并且已经初始化了Git仓库,但还没有提交任何文件): 1. 创建.gitignore文件:`echo "README.md" > .gitignore` 2. 添加.gitignore到暂存区:`git add .gitignore` 3. 提交:`git commit -m "Add .gitignore to ignore README.md"` 这样,README.md就不会被跟踪,版本回退也不会影响它。 如果已经将README.md添加到暂存区(执行了`git add README.md`): 1. 从暂存区移除:`git reset HEAD README.md` 或者 `git rm --cached README.md` 2. 然后创建.gitignore并忽略README.md(同上) 如果已经提交了README.md: 1. 从版本库中移除:`git rm --cached README.md` 2. 创建.gitignore并忽略README.md 3. 提交.gitignore 最后,注意:如果项目已经推送到远程仓库,那么执行`git rm --cached README.md`并提交推送后,远程仓库的README.md会被删除。如果希望保留远程仓库的README.md,那么不要执行`git rm --cached`,而是使用`git update-index --assume-unchanged README.md`来临时忽略修改。但是,这种方法不是永久的,而且不会影响其他开发者。 因此,根据用户需求(防止版本回退更改),我们建议使用永久忽略(即.gitignore+移除跟踪),但要注意远程仓库的README.md会被删除(如果之前存在)。如果用户希望保留远程仓库的README.md,那么需要重新考虑。 由于问题描述中并没有提到远程仓库,我们假设用户只关心本地。 所以,我们给出通用步骤(假设已经存在README.md,并且已经初始化Git仓库): 1. 如果README.md已经被跟踪(在暂存区或已提交),则执行:`git rm --cached README.md` 2. 创建或修改.gitignore文件,添加一行:`README.md` 3..gitignore添加到暂存区:`git add .gitignore` 4. 提交:`git commit -m "Ignore README.md"` 这样,README.md的修改将被忽略,版本回退也不会更改它。 注意:如果还没有初始化仓库,先执行`git init`。 如果还没有创建README.md,那么先创建.gitignore并添加规则,然后再创建README.md,这样README.md就不会被跟踪。 总结:关键是将README.md排除在版本控制之外。 下面,我们按照用户要求,提供具体的命令行操作。 </think>### 在未创建.gitignore时添加并忽略README文件的解决方案 #### 完整操作流程 1. **初始化仓库(若未初始化)** ```bash git init ``` 2. **创建README文件** ```bash echo "# Project Title" > README.md ``` 3. **移除文件的版本跟踪(关键步骤)** ```bash git rm --cached README.md # 从索引移除但保留本地文件 ``` 4. **创建.gitignore并添加规则** ```bash echo "README.md" > .gitignore # 创建忽略文件 ``` 5. **提交.gitignore文件** ```bash git add .gitignore git commit -m "添加.gitignore并忽略README.md" ``` 6. **验证忽略效果** ```bash echo "修改内容" >> README.md git status # 应显示"working tree clean" ``` #### 效果说明 - ✅ **README.md保留在本地**:可自由修改 - ✅ **版本控制忽略**:`git status`不显示修改 - ✅ **版本回退免疫**:`git reset/revert`不影响文件内容 - ❌ **远程仓库不可见**:文件不会同步到远程(其他开发者需自行创建)[^3] #### 备选方案(需保留初始版本) 若需在远程保留初始README但忽略后续修改: ```bash # 1. 提交初始版本 git add README.md git commit -m "初始README" # 2. 停止跟踪并忽略 git rm --cached README.md echo "README.md" >> .gitignore git add .gitignore git commit -m "忽略README后续修改" ``` > 💡 此时远程仓库保留初始README,但后续本地修改不会被跟踪[^1] #### 注意事项 1. **协作影响** 此方法会导致README.md**不在远程仓库**,需确保: - 其他开发者知晓需手动创建 - 重要文档建议通过`git update-index --assume-unchanged`临时忽略[^2] 2. **文件恢复方法** 如需重新跟踪文件: ```bash git update-index --no-assume-unchanged README.md # 恢复跟踪 # 或 git add -f README.md # 强制添加被忽略文件 ``` 3. **最佳实践** ```mermaid graph LR A[新项目开始] --> B[立即创建.gitignore] B --> C{文件类型} C -->|核心文档| D[正常提交] C -->|本地配置| E[git rm --cached] ``` > 📌 核心原则:`.gitignore`对**已跟踪文件无效**,必须先解除跟踪[^1][^4]
评论
成就一亿技术人!
拼手气红包6.0元
还能输入1000个字符
 
红包 添加红包
表情包 插入表情
 条评论被折叠 查看
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值