Clean up repository data
One of Git's benefits is its ability to efficiently store long histories for repositories. However, there are times when you need to clean up data.
The most common situations are when you want to:
- Make a repository smaller by removing history
- Remove a large file that was accidentally uploaded
- Remove a sensitive file that shouldn't have been uploaded
If you commit sensitive data (like passwords or keys) to Git, you can remove it from history. Two tools are commonly used:
git filter-repo tool
The git filter-repo is a tool for rewriting history.
Its core filter-repo contains a library for creating history rewriting tools. Users with specialized needs can quickly create entirely new history rewriting tools.
Note
More details are in the repository git-filter-repo.
BFG Repo-Cleaner
BFG Repo-Cleaner is a commonly used open-source tool for deleting or "fixing" content in repositories. It's easier to use than the git filter-branch command. For a single file or set of files, use the --delete-files option:
$ bfg --delete-files file_I_should_not_have_committed
The following example shows how to find all the places where a file called passwords.txt exists in the repository. To replace all the text in it, you can use the --replace-text option:
$ bfg --replace-text passwords.txt
For more information, see:
Quickly rewrite git repository history
Removing files from Git Large File Storage