Commit 052749ef authored by Lyle Kozloff's avatar Lyle Kozloff Committed by Evan Read

documentation update - note that BFG is an open source community project

parent 257289f3
...@@ -15,7 +15,7 @@ will not actually reduce the size of your repository because ...@@ -15,7 +15,7 @@ will not actually reduce the size of your repository because
the files are still referenced by previous commits. the files are still referenced by previous commits.
Through the method described on this document, first migrate Through the method described on this document, first migrate
to Git LFS with [BFG](https://rtyley.github.io/bfg-repo-cleaner/) to Git LFS with a tool such as the open source community-maintained [BFG](https://rtyley.github.io/bfg-repo-cleaner/)
through a mirror repo, then clean up the repository's history, through a mirror repo, then clean up the repository's history,
and lastly create LFS tracking rules to prevent new binary files and lastly create LFS tracking rules to prevent new binary files
from being added. from being added.
......
...@@ -487,9 +487,9 @@ git filter-branch --tree-filter 'rm filename' HEAD ...@@ -487,9 +487,9 @@ git filter-branch --tree-filter 'rm filename' HEAD
Since `git filter-branch` command might be slow on big repositories, there are Since `git filter-branch` command might be slow on big repositories, there are
tools that can use some of Git specifics to enable faster execution of common tools that can use some of Git specifics to enable faster execution of common
tasks (which is exactly what removing sensitive information file is about). tasks (which is exactly what removing sensitive information file is about).
An alternative is [BFG Repo-cleaner][bfg-repo-cleaner]. Keep in mind that these An alternative is the open source community-maintained tool [BFG][bfg-repo-cleaner].
tools are faster because they do not provide a same fully feature set as `git filter-branch` Keep in mind that these tools are faster because they do not provide the same
does, but focus on specific use cases. feature set as `git filter-branch` does, but focus on specific use cases.
## Conclusion ## Conclusion
......
...@@ -19,7 +19,8 @@ Unfortunately, it's not so easy and that workflow won't work. Deleting files in ...@@ -19,7 +19,8 @@ Unfortunately, it's not so easy and that workflow won't work. Deleting files in
a commit doesn't actually reduce the size of the repo since the earlier commits a commit doesn't actually reduce the size of the repo since the earlier commits
and blobs are still around. What you need to do is rewrite history with Git's and blobs are still around. What you need to do is rewrite history with Git's
[`filter-branch` option](https://git-scm.com/book/en/v2/Git-Tools-Rewriting-History#The-Nuclear-Option:-filter-branch), [`filter-branch` option](https://git-scm.com/book/en/v2/Git-Tools-Rewriting-History#The-Nuclear-Option:-filter-branch),
or a tool like the [BFG Repo-Cleaner](https://rtyley.github.io/bfg-repo-cleaner/). or an open source community-maintained tool like the
[BFG](https://rtyley.github.io/bfg-repo-cleaner/).
Note that even with that method, until `git gc` runs on the GitLab side, the Note that even with that method, until `git gc` runs on the GitLab side, the
"removed" commits and blobs will still be around. You also need to be able to "removed" commits and blobs will still be around. You also need to be able to
...@@ -34,8 +35,9 @@ temporarily increase it for you, your only option is to prune all the unneeded ...@@ -34,8 +35,9 @@ temporarily increase it for you, your only option is to prune all the unneeded
stuff locally, and then create a new project on GitLab and start using that stuff locally, and then create a new project on GitLab and start using that
instead. instead.
If you can continue to use the original project, we recommend [using the If you can continue to use the original project, we recommend [using
BFG Repo-Cleaner](#using-the-bfg-repo-cleaner). It's faster and simpler than BFG](#using-the-bfg-repo-cleaner), a tool that's built and
maintained by the open source community. It's faster and simpler than
`git filter-branch`, and GitLab can use its account of what has changed to clean `git filter-branch`, and GitLab can use its account of what has changed to clean
up its own internal state, maximizing the space saved. up its own internal state, maximizing the space saved.
...@@ -54,7 +56,7 @@ removed from the repository. ...@@ -54,7 +56,7 @@ removed from the repository.
> [Introduced](https://gitlab.com/gitlab-org/gitlab-foss/issues/19376) in GitLab 11.6. > [Introduced](https://gitlab.com/gitlab-org/gitlab-foss/issues/19376) in GitLab 11.6.
1. [Install BFG](https://rtyley.github.io/bfg-repo-cleaner/). 1. [Install BFG](https://rtyley.github.io/bfg-repo-cleaner/) from its open source community repository.
1. Navigate to your repository: 1. Navigate to your repository:
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment