Skip to content

Latest commit

 

History

History
62 lines (45 loc) · 3.51 KB

ignoring-files.md

File metadata and controls

62 lines (45 loc) · 3.51 KB
Raw
title redirect_from intro versions
Ignoring files
/git-ignore
/ignore-files
/articles/ignoring-files
/github/using-git/ignoring-files
/github/getting-started-with-github/ignoring-files
/github/getting-started-with-github/getting-started-with-git/ignoring-files
You can configure Git to ignore files you don't want to check in to {% data variables.product.product_name %}.
fpt ghes ghec
*
*
*

Configuring ignored files for a single repository

You can create a .gitignore file in your repository's root directory to tell Git which files and directories to ignore when you make a commit. To share the ignore rules with other users who clone the repository, commit the .gitignore file in to your repository.

GitHub maintains an official list of recommended .gitignore files for many popular operating systems, environments, and languages in the "github/gitignore" public repository. You can also use gitignore.io to create a .gitignore file for your operating system, programming language, or IDE. For more information, see "github/gitignore" and the "gitignore.io" site.

{% data reusables.command_line.open_the_multi_os_terminal %}

  1. Navigate to the location of your Git repository.

  2. Create a .gitignore file for your repository.

    touch .gitignore

    If the command succeeds, there will be no output.

For an example .gitignore file, see "Some common .gitignore configurations" in the Octocat repository.

If you want to ignore a file that is already checked in, you must untrack the file before you add a rule to ignore it. From your terminal, untrack the file.

git rm --cached FILENAME

Configuring ignored files for all repositories on your computer

You can tell Git to always ignore certain files or directories when you make a commit in any Git repository on your computer. For example, you could use this feature to ignore any temporary backup files that your text editor creates.

To always ignore a certain file or directory, add it to a file named ignore that's located inside the directory ~/.config/git. By default, Git will ignore any files and directories that are listed in the global configuration file ~/.config/git/ignore. If the git directory and ignore file don't exist yet, you may need to create them.

Excluding local files without creating a .gitignore file

If you don't want to create a .gitignore file to share with others, you can create rules that are not committed with the repository. You can use this technique for locally-generated files that you don't expect other users to generate, such as files created by your editor.

Use your favorite text editor to open the file called .git/info/exclude within the root of your Git repository. Any rule you add here will not be checked in, and will only ignore files for your local repository.

{% data reusables.command_line.open_the_multi_os_terminal %}

  1. Navigate to the location of your Git repository.
  2. Using your favorite text editor, open the file .git/info/exclude.

Further Reading