This Bash script automates the process of mirroring a Git repository while updating author and committer email addresses in the commit history. It is useful for transferring a repository to a new remote location and ensuring that the commit history reflects the correct author information.
-
User Input Prompts: The script prompts the user for essential information:
- Repository URL to clone
- Old email address to change
- New email address to use
- Correct name associated with the new email
- New repository URL for mirroring
-
Repository Cloning: Uses
git clone --mirrorto create a bare clone of the specified repository, including all branches and tags. -
Commit History Modification: Utilizes
git filter-branchto update author and committer details in the commit history based on user input. -
Remote URL Update: Updates the remote origin URL to point to the new repository after modifying the commit history.
-
Push Changes: Pushes all branches and tags from the local mirror to the new remote repository using
git push --mirror.
- Ensure that Git is installed on your system.
- Make sure you have access rights to both the original and new repositories.
- Save this script
mirror_repo.shor
curl --O https://raw.githubusercontent.com/dev-kraken/mirror_repo/main/mirror_repo.sh- Make it executable by running:
chmod +x mirror_repo.sh - Execute the script by running:
./mirror_repo.sh- Follow the prompts to enter the required information.
Suppose you have a Git repository hosted on GitHub with an old email address associated with your commits. You want to migrate this repository to a new location (e.g., another GitHub account or a different platform) while correcting your email address in all past commits. This script simplifies that process by handling everything in one go.
- This script is designed for use in environments that support Bash (e.g., Linux, macOS, Windows with Git Bash).
- The use of
git filter-branchmay take some time depending on the size of your repository and its commit history. - After running this script, ensure you verify that all changes have been applied correctly in your new remote repository.