Monorepo Spring Cleaning

@pmartindev

Prerequisites • Resources

This workshop is a hands-on session to help you clean up your monorepo. We will be using popular open source tools to discover and aid in the removal of large binaries. We will also learn methods of decreasing the size of our repository, but still preserving git history by using git replace to graft two repositories together.

📣 Prerequisites

To run the workshop locally, you will need to install the following:

Tools

• Git 2.34 or newer
  • Linux
  • MacOS
  • Windows
• git filter-repo
  • Requires python3 >= 3.5
  • pip3 install git-filter-repo
• git-sizer
  • Download and extract a .zip for the appropriate platform
  • Alternatively, if you have go installed, you can run install git-sizer with the go package manager:
    • go get github.com/github/git-sizer

Repository

If you do not have a local fresh clone of a monorepo of your own to experiment with, you may also clone from the example repo that is used throughout the examples in this workshop:

• Clone git-merge-workshops/a-bad-monorepo

git clone https://github.com/git-merge-workshops/a-bad-monorepo.git

You will then want to create an additional copy of the repository as we experiment with different methods of clean up.

cp -r a-bad-monorepo a-bad-monorepo-filter-repo

🔍 Activity 1: Analyze

Gathering overall stats with git-sizer

Git Sizer Stats

Gathering blob sizing with git filter-repo

Git Filter-repo Stats

🧹 Activity 2: Clean up

Rewriting History with git filter-repo

History Rewrite

⛓️ Activity 3: Grafting

Git replace

Git Replace

Grafting a repository

Repository Grafting

⭐ Final Conclusion

Thank you for taking the time to walkthrough this workshop on cleaning your monorepo!:tada: I hope you learned something new and are able to apply some of these techniques in your own monorepo analysis. Please check out the other presentations on Monorepos at Git Merge 2022.

📚 Resources

• The Monorepo Book
• Measuring the Many Sizes of a Git Repository
• git-replace