https://github.com/githubtraining/example-filter-branch
example of filtering a branch to remove a large binary asset commit
https://github.com/githubtraining/example-filter-branch
Last synced: 8 months ago
JSON representation
example of filtering a branch to remove a large binary asset commit
- Host: GitHub
- URL: https://github.com/githubtraining/example-filter-branch
- Owner: githubtraining
- Archived: true
- Created: 2015-04-01T23:34:23.000Z (almost 11 years ago)
- Default Branch: master
- Last Pushed: 2015-04-02T22:14:12.000Z (almost 11 years ago)
- Last Synced: 2025-03-14T07:21:22.691Z (10 months ago)
- Size: 3.22 MB
- Stars: 2
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# filter-branch-example
example of filtering a branch to remove a large binary asset commit
**Warning from Git Docs Concerning Filter Branch:**
WARNING! The rewritten history will have different object names for all the objects and will not converge with the original branch. You will not be able to easily push and distribute the rewritten branch on top of the original branch. Please do not use this command if you do not know the full implications, and avoid using it anyway, if a simple single commit would suffice to fix your problem.
Performing this action rewrites the commit history. I needed to do a `force push` to push my repo to origin after performing this action. These actions (both force pushes and filter-branch) are dangerous actions to perform when working with other people. Their history and origin's history will diverge if you use these operations.
If you use `force push` you may also be removing commits they recently made from master. Extreme caution should be used and coordination with other team members is a must.
### Steps Taken to Remove Large File
- Created repo
- Added three files and committed
- Added iTerm2 zip file (large file to be removed)
- Added three more commits
- Executed a `filter-branch` command. Here it is:
- ```
git filter-branch --force --index-filter \
'git rm --cached --ignore-unmatch iTerm2_v2_0.zip' \
--prune-empty --tag-name-filter cat -- --all
```
- After git rewrites history and removes iTerm2 file I force pushed my repository to origin and all traces of the iTerm2 file were gone.
**Commit History on Origin with Binary Included Before Filter-Branch**
**Commit History After Filter Branch (Step 5 Above) Was Executed:**
[Simple Filter Branch Demo](https://help.github.com/articles/remove-sensitive-data/) at GitHub in the context of removing sensitive data, but the process is the same for a large binary asset.
[BFR Repo-Cleaner](https://rtyley.github.io/bfg-repo-cleaner/) is a faster alternative to filter-branch. It works well for removing large files and similar tasks.
## Splicing in One Branch into The Middle of Another
Let's say you want to take one orphaned branch (commits X,Y and Z in our example) and splice it into your master branch (between commits B and C). Here is a picture of the example:
You can use rebase for this and have it done in a few steps. Here is an example of the process:
-