Skip to content

Update reduce repo size docs to use `git filter-repo`

James Ramsay (ex-GitLab) requested to merge reduce-repo-size into master

What does this MR do?

Purging data from a Git repo can be useful for different reasons, including making cloning faster, or reducing repo size on the GitLab server. The first is easy, the second is hard.

Documentation has been rewritten to use git filter-repo which is the leading repo rewriting tool for this application, and is recommended by the Git project.

Documentation now also provides workflow for pruning all kinds of refs, including refs/keep-around/* which was not documented. This meant purging files was incomplete from disk use perspective on the GitLab server.

References to BFG have been removed.

Related issues

Related gitaly!2247 (merged)

Closes #219718 (closed)

Closes #33472 (closed)

Author's checklist (required)

When applicable:

Review checklist

All reviewers can help ensure accuracy, clarity, completeness, and adherence to the Documentation Guidelines and Style Guide.

1. Primary Reviewer

  • Review by a code reviewer or other selected colleague to confirm accuracy, clarity, and completeness. This can be skipped for minor fixes without substantive content changes.

2. Technical Writer

  • Optional: Technical writer review. If not requested for this MR, must be scheduled post-merge. To request for this MR, assign the writer listed for the applicable DevOps stage.

3. Maintainer

  1. Review by assigned maintainer, who can always request/require the above reviews. Maintainer's review can occur before or after a technical writer review.
  2. Ensure a release milestone is set.
  3. If there has not been a technical writer review, create an issue for one using the Doc Review template.
Edited by 🤖 GitLab Bot 🤖

Merge request reports