Difference between .gitignore and .gitkeep
Git is a command line tool which is widely used for changes in source code during software development processes. It was developed by the Linux Torvalds in 2005 to manage the Linux Kernel development. This post will show the difference between the .gitignore and .gitkeep files.
What is a .gitignore file?
It is a text-based file in Git repositories that specifies intentionally tracked files and directories that Git must ignore. Sometimes developers don’t want to add some sensitive file in Git history. There, this file comes in the picture. The developer specifies those files in this file to ignore these files in the git history.
Syntax:
The syntax of .gitignore file is very simple, developers have to specify files, directories, or patterns to ignore. Anything you write in .gitignore file will be ignored by the Git system.
Example: The “secrets.txt” file never commit in Git repository
//.gitignore file
secrets.txt
Output
Benefits of “.gitignore” files
Here’s is the some benefits of “.gitignore” files
- Prevent Unwanted file from being tracked: The primary benefits of a “.gitignore” file is that it specifies intentionally untracked files to ignore by Git tool.
- Improve performance: Ignorriing unessarry file can improve the performance of Git operations. This increase the improve performance of some commands like “git status”, “git add” and others commands.
- Collaborations Enhances: A “.gitignore” file also helps developer to contribute on same project. However, It ignroes the necessary files.
What is a .gitkeep file?
The ‘.gitkeep’ file is not officially git feature. It is a convention used to in Git repositories to ensure that empty directories must be tracked by the Git. By Design Git does not track the empty directories. It can be problematic sometimes when a developer wants to make structure of the project.
Example : Create a file using the following command in your directory.
$ touch /Project/.gitkeep
Adding gitkeep file in git repository
Benefits of ‘.gitkeep’ file
Here’s is the some benefits of the ‘.gitkeep’ file
- Directory Structure: By default git does not track empty directories. By using ‘.gitkeep’ file in an empty directory, you can ensure that directory structure is preserved in the repository. It might be help in some workflows or applications that expect specific directory structure or project structure.
- Enhance Collaboration: When you are working with team, having the directory structure predefined help team member to work with specific directory easily without any problem.
- Repository Consistency: A ‘.gitkeep’ file make the repository consistency easily by defining the project structure using the ‘.gitkeep’ file.
Difference between .gitignore and .gitkeep files?
|
Features |
‘.gitignore’ |
‘.gitkeep’ |
|---|---|---|
|
Purpose |
It specifies file and directories should by ignore by git |
It ensures the empty directory must be tracked by Git |
|
File Content |
It uses filename, and pattern for ignoring the file in Git |
It is just a empty hidden file in your directory |
|
Use Case |
Ignorind complied files, temporary files, system specific files |
Keep the directory even if the directory is empty |
|
Syntax |
*.log to ignore all log files |
It has specific syntax |
|
Impact |
Prevent unwanted to file to tracked in Git |
Allows empty folder to track in Git |
Conclusion
In Git both files server different purposes. However, .gitkeep is not feature of Git Version Control System. It helps developer to add empty directory for tacking in Git and gitignore file used for untrack important or secrets files in Git history. Together, they maintain clean and efficient code in Git and also increase the productivity of the Developer.