How can I ignore directories or folders in Git using msysgit on Windows?
21 Answers
Create a file named .gitignore
in your project's directory. Ignore directories by entering the directory name into the file (with a slash appended):
dir_to_ignore/
More information is here.
-
152In a windows cmd prompt you can either use 'edit .gitignore' or 'notepad .gitignore' to create the correct file. May 9, 2011 at 16:08
-
53Or you can also use 'touch .gitignore' from within the windows git bash command prompt and that will create the correctly named file which can then in turn be edited by notepad or the like...– SGBNov 22, 2011 at 21:48
-
42Or just create a file named .gitignore. with explorer and edit it with notepad (the trailing dot will be removed). That way you don't have to use command prompt. Mar 30, 2012 at 0:01
-
6
-
44Or, which surprisingly has not been mentioned even though it is the fastest way, just type "echo folder_to_ignore>> .gitignore" in the console.– GodsmithFeb 9, 2014 at 6:49
By default, Windows Explorer will display .gitignore
when in fact the file name is .gitignore.txt
.
Git will not use .gitignore.txt
And you can't rename the file to .gitignore
, because Windows Explorer thinks it's a file of type gitignore without a name.
Non command line solution:
You can rename a file to ".gitignore.", and it will create ".gitignore"
-
60That works? I've always just told people to open notepad and in the Save As dialog type the filename surrounded by doublequotes, so for example
".gitignore"
and it saves it without automatically adding an extension. Feb 10, 2011 at 17:44 -
13Neat. Including a trailing period does work. Explorer strips off the last period, resulting in a file named ".gitignore". I think the quotes method is cleaner though and less likely to create surprises.– TriynkoSep 8, 2011 at 22:29
-
8Or, in the Save As dialog, change the file type to "All Files (.)" - then Windows will not append any extension. Mar 26, 2014 at 2:20
-
7
-
6
".gitignore."
- This is great trick ! I always had trouble with.htaccess
as well... Apr 19, 2016 at 7:07
It seems that for ignoring files and directories there are two main ways:
.gitignore
- Placing
.gitignore
file into the root of your repository besides the.git
folder (in Windows, make sure you see the true file extension and then make.gitignore.
(with the point at the end to make an empty file extension)) - Making the global configuration
~/.gitignore_global
and runninggit config --global core.excludesfile ~/.gitignore_global
to add this to your Git configuration
Note: files tracked before can be untracked by running
git rm --cached filename
- Placing
Repository exclude - For local files that do not need to be shared, you just add the file pattern or directory to the file
.git/info/exclude
. Theses rules are not committed, so they are not seen by other users. More information is here.
To make exceptions in the list of ignored files, see this question.
-
51good job pointing out the
git rm --cached <filename>
. Absolutely critical for repos that existed BEFORE you created the.gitignore
Jun 3, 2012 at 1:06 -
2git rm --cached <filename> fixed the problem I was having with .gitignore :) Mar 17, 2013 at 23:27
-
1Yeah git rm --cached filename is absolutely crucial. It was driving me crazy as git was still staging files I clearly stated to be ignored (created gitignore after initial commit). Thank you very much!– PotaitoOct 8, 2013 at 16:55
-
1Solved my problem. Git was tracking vendor folder in my laravel repo even though I had added vendor folder in gitignore. Thanks alot.– JayantAug 31, 2015 at 5:50
-
my builds folder was being tracked. It must have been added to .gitignore after a build. Anyway, the command to untrack the folder is this: git rm --cached builds -r (where builds is the folder you want to untrack and -r is recursive meaning all files and sub-folders will be untracked) Nov 9, 2020 at 15:39
To ignore an entire directory place a .gitignore of “*” there.
For example,
Example System
/root/
.gitignore
/dirA/
someFile1.txt
someFile2.txt
/dirB/
.gitignore
someFile3.txt
someFile4.txt
Goal
- ignore the contents of dirB/
Top Level (/root/.gitignore)
- You could just “dirB/“ here
Ignored Directory (/root/dirB/.gitignore)
- Or you could “*” here
Git watches for gitignore at every step of the file system. So here I choose dirB/.gitignore as “*” to ignore dirB/, including all files and subdirs within.
Done ☺️
-
4What is the standard gitignore info? Can you give an example? What do you mean when you say "the file just reads as * ", this doesn't make any sense? I don't think I understood anything from this answer and couldn't find it at all simple. Jun 25, 2020 at 4:38
-
1The file is one character, a single ‘*’. I will review and share further detail in a bit– J-DizzleJun 25, 2020 at 6:37
-
1I feel this is cleaner because it doesn't clutter your main .gitignore file Dec 29, 2020 at 6:34
-
1Elaborate please - I am not sure what you are saying! Share more detail and I will update– J-DizzleJan 31, 2021 at 19:04
-
1@skdhfgeq2134: In programming, the asterisk * is short for "all" or "everything." So in this case "*" means everything in the directory. Sep 14, 2021 at 17:29
To instruct Git to ignore certain files or folders, you have to create .gitignore
file.
But in Windows Explorer you have to provide a name for the file. You just cannot create file with just an extension. The trick is that create a empty text file and go to command prompt and change the name of the file to .gitignore
:
ren "New Text Document.txt" .gitignore
Now open the file with your favorite text editor and add the file/folder names you wish you ignore. You can also use wildcards like this: *.txt
.
-
15
-
2
-
Or just call the file
.gitignore.
when the file extensions are not hidden in your Windows explorer– VairisMay 6, 2015 at 11:43
I had some issues creating a file in Windows Explorer with a .
at the beginning.
A workaround was to go into the commandshell and create a new file using "edit".
-
2or just add an extra
.
at the end so explorer stops thinking.gitignore
is the extension. Then on entry that trailing dot with no extension just gets eaten and you are left with.gitignore
TL;DR: try to name it.gitignore.
=> you end up with.gitignore
– leerssejFeb 25, 2018 at 20:13
If you want to maintain a folder and not the files inside it, just put a ".gitignore" file in the folder with "*" as the content. This file will make Git ignore all content from the repository. But .gitignore
will be included in your repository.
$ git add path/to/folder/.gitignore
If you add an empty folder, you receive this message (.gitignore is a hidden file)
The following paths are ignored by one of your .gitignore files:
path/to/folder/.gitignore
Use -f if you really want to add them.
fatal: no files added
So, use "-f" to force add:
$ git add path/to/folder/.gitignore -f
In Windows there's an extra catch with slashes. Excluding a single directory in .gitignore with
dir_to_exclude/
will possibly work, but excluding all directories with
/
causes problems when you have file names with spaces (like my file.txt
) in your directory: Git Bash escapes these spaces with a backslash (like my\ file.txt
) and Git for Windows doesn't distinguish between /
and \
.
To exclude all directories, better use:
**/
Two consecutive asterisks signify directory contents.
You can create the ".gitignore" file with the contents:
*
!.gitignore
It works for me.
-
4This is the best answer, it also brings added benefits in project deployment and maintenance.– Nitin...Jun 20, 2016 at 9:24
-
1I needed to also add /.gitgnore to also ignore the file .gitignore itself Dec 21, 2020 at 2:42
-
Why !.gitignore with an exclamation point? The docs say the ! symbol negates instructions. Simply including * and .gitignore should work. More related details: stackoverflow.com/questions/10176875/add-gitignore-to-gitignore/10177000 Sep 14, 2021 at 18:18
Just in case you need to exclude sub folders you can use the **
wildcard to exclude any level of sub directory.
**/build/output/Debug/
Also in your \.git\info
projects directory there is an exclude file that is effectively the same thing as .gitignore
(I think). You can add files and directories to ignore in that.
-
I like this approach, I just can't get along with the path in there, I want to ignore a folder in the main repo, how to? May 18, 2017 at 6:50
-
But aren't you supposed to leave files in .git alone (manipulate the content through official means)? Nov 14, 2019 at 13:55
When everything else fails try editing the file
/.git/info/exclude
and adding the directories you want to the end of the file, like this:
# git ls-files --others --exclude-from=.git/info/exclude
# Lines that start with '#' are comments.
# For a project mostly in C, the following would be a good set of
# exclude patterns (uncomment them if you want to use them):
# *.[oa]
# *~
assets/
compiled/
I added the folders "assets" and "compiled" to the list of files and directories to ignore.
-
1
-
I tried all the others with my current configuration and this was my ultimate definitive answer.– XedretNov 14, 2018 at 19:59
I've had some problems getting Git to pick up the .gitignore
file on Windows. The $GIT_DIR/info/exclude
file always seems to work though.
The downside of this approach, however, is that the files in the $GIT_DIR
directory are not included in the check-in, and therefore not shared.
p.s.
$GIT_DIR
is usually the hidden folder named.git
-
Yes, git on windows is really finicky about .gitignore - the local exclude file does what I need though. Thanks!– andersopJul 26, 2012 at 0:39
On Unix:
touch .gitignore
On Windows:
echo > .gitignore
These commands executed in a terminal will create a .gitignore
file in the current location.
Then just add information to this .gitignore
file (using Notepad++ for example) which files or folders should be ignored. Save your changes. That's it :)
More information: .gitignore
-
"Then just add information.." You brushed over a relatively important step there.– TarynnSep 22, 2021 at 14:40
I assume the problem is that your working tree is like:
a-cache/foo
a-cache/index.html
b-cache/bar
b-cache/foo
b-cache/index.html
.gitignore
... with the .gitignore
you describe. This will give you git status
output like:
$ git status
# On branch master
# Untracked files:
# (use "git add <file>..." to include in what will be committed)
#
# .gitignore
# a-cache/
# b-cache/
... if the index.html
files have not yet been added to the repository. (Git sees that there are unignored files in the cache directories, but it only reports the directories.) To fix this, make sure that you have added and committed the index.html
files:
git add *cache/index.html
git commit -m "Adding index.html files to the cache directories"
... and your git status
will then look like:
$ git status
# On branch master
# Untracked files:
# (use "git add <file>..." to include in what will be committed)
#
# .gitignore
nothing added to commit but untracked files present (use "git add" to track)
(Obviously you do want to commit .gitignore
as well. I was just being lazy with this test case.)
-
1You probably do want to commit .gitignore especially as you're likely to want to track changes to it, and so is your team (if you're working with one). See stackoverflow.com/a/767213/123033 Jan 15, 2013 at 14:24
-
2@Dave Everitt: That's exactly why i said "Obviously you do want to commit .gitignore as well". Jan 15, 2013 at 15:16
On Windows and Mac, if you want to ignore a folder named Flower_Data_Folder in the current directory, you can do:
echo Flower_Data_Folder >> .gitignore
If it's a file named data.txt
:
echo data.txt >> .gitignore
If it's a path like "Data/passwords.txt"
echo "Data/passwords.txt" >> .gitignore.
I had similar issues. I work on a Windows tool chain with a shared repository with Linux guys, and they happily create files with the same (except for case) names in a given folder.
The effect is that I can clone the repository and immediately have dozens of 'modified' files that, if I checked in, would create havoc.
I have Windows set to case sensitive and Git to not ignore case, but it still fails (in the Win32 API calls apparently).
If I gitignore the files then I have to remember to not track the .gitignore file.
But I found a good answer here:
http://archive.robwilkerson.org/2010/03/02/git-tip-ignore-changes-to-tracked-files/index.html
-
The link appears to be broken (it first redirects to the 'https' version): "Secure Connection Failed. An error occurred during a connection to archive.robwilkerson.org. PR_END_OF_FILE_ERROR" Nov 14, 2019 at 14:23
Just create .gitignore
file in your project folder Then add the name of the folder in it for ex:
frontend/node_modules
-
-
1frontend/node_modules folder; if u have backend and frontend for your app you can specify the ignore of node modules by typing the name of the front end folder /node_modules :) Sep 22, 2021 at 18:48
This might be extremely obvious for some, but I did understand this from the other answers.
Making a .gitignore file in a directory does nothing by itself. You have to open the .gitignore as a text file and write the files/directories you want it to ignore, each on its own line.
so cd to the Git repository directory
touch .gitignore
nano .gitignore
and then write the names of the files and or directories that you want to be ignored and their extensions if relevant.
Also, .gitignore is a hidden file on some OS (Macs for example) so you need ls -a
to see it, not just ls.
Temporarily ignore a directory/file that was already in git:
I have a lot of projects in a multi-project gradle project and they can take a long time to delete them, and they're all pretty much the same but different. From time to time I want to remove those from the gradle build by deleting them altogether. git can get them back after all. However I don't want them showing up in git status either. So I use the following simple procedure;
- delete files and folders I don't want.
- verify build still works
- tell git to ignore the deleted files for a bit (we can get them back)
git ls-files --deleted -z | git update-index --assume-unchanged -z --stdin
- go about life without the dirs until you want them back. Then run the same command as before but switch out assume-unchanged for no-assume-unchanged
git ls-files --deleted -z | git update-index --no-assume-unchanged -z --stdin
For those for whom the above answers didn't work. The process is pretty simple.
- Go into plastic scm app and select your Workspace Explorer window
- Notice that the folder you want to ignore has a green tick on it
- Right click on it and select "Delete"
- In the pop-up window, select "Dont delete from disk"
- Now simply add the folder name to ignore.conf file in root of project
.gitkeep
) to indicate a directory that should be kept/
at the end what makes it know its a directory it should ignore?