HOWTO · Git
Entfernen ein Submodul in Git
In diesem Tutorial geht es um das Entfernen von Submodulen in Git
Auf dieser Seite
Das Entfernen eines Submoduls in Git erfordert zwei Befehle aus dem Stammverzeichnis des Superprojekts: git submodule deinit <path>, um es lokal abzumelden, und anschließend git rm <path>, um den versionierten Eintrag zu löschen und die Änderung zu stagen. Ein Submodul ist ein eigenständiges Git-Repository, das das Superprojekt über einen gitlink im Index und einen Eintrag in .gitmodules verfolgt; das Entfernen betrifft daher den Arbeitsbaum, den Index und diese Konfigurationsdatei gemeinsam.
Projekte binden häufig eine externe Bibliothek oder eine gemeinsam genutzte Komponente als Submodul ein und halten deren Historie dabei vom Hauptrepository getrennt. Wenn diese Abhängigkeit nicht mehr benötigt wird, entfernen die folgenden Schritte sie sauber – am Beispiel eines Submoduls mit dem Namen good-ext-lib.
Ein Git-Submodul entfernen
Führen Sie die folgenden Befehle im Stammverzeichnis des Superprojekts aus und ersetzen Sie path/to/good-ext-lib durch den Pfad des Submoduls, wie er in .gitmodules steht:
git submodule deinit path/to/good-ext-libgit rm path/to/good-ext-lib
Das ist bereits das gesamte Entfernen. Im Normalfall benötigt keiner der beiden Befehle eine Force-Option: Ergänzen Sie -f bei git submodule deinit nur, um nicht committete Arbeit innerhalb des Submoduls zu verwerfen, und bei git rm nur, um ein Submodul zu entfernen, das noch lokale Änderungen oder gestagte Inhalte enthält. Beide Varianten sind destruktiv und verwerfen Arbeit; setzen Sie sie daher nur ein, wenn genau das beabsichtigt ist.
Führen Sie dieses in sich geschlossene Beispiel aus, um die gesamte Sequenz in einem Test-Repository auszuprobieren:
Der Code und die angezeigten Bezeichnungen oder Ausgaben in diesem Abschnitt bleiben auf Englisch.
set -e
demo=$(mktemp -d)
git init -q -b main "$demo/lib"
git -C "$demo/lib" config user.email demo@example.com
git -C "$demo/lib" config user.name Demo
echo "demo library" > "$demo/lib/README.md"
git -C "$demo/lib" add README.md
git -C "$demo/lib" commit -qm "Initial library commit"
git init -q -b main "$demo/super"
git -C "$demo/super" config user.email demo@example.com
git -C "$demo/super" config user.name Demo
git -C "$demo/super" -c protocol.file.allow=always submodule add -q "$demo/lib" good-ext-lib
git -C "$demo/super" commit -qm "Add good-ext-lib submodule"
git -C "$demo/super" submodule deinit good-ext-lib
git -C "$demo/super" rm -q good-ext-lib
git -C "$demo/super" status --short
Das Skript erstellt ein kleines Bibliotheks-Repository, bindet es als Submodul in ein Test-Superprojekt ein und deinitialisiert und entfernt es anschließend; der abschließende Statusbefehl listet das gestagte Ergebnis auf. Um die Sequenz auf ein echtes Repository zu übertragen, passen Sie die letzten drei git -C "$demo/super"-Zeilen an, indem Sie dieselben Unterbefehle – submodule deinit, rm und status – ohne -C im Projektstamm ausführen.
Was jeder Befehl ändert
git submodule deinit path/to/good-ext-lib wirkt sich nur auf den lokalen Klon aus. Der Befehl entfernt die Registrierung submodule.good-ext-lib aus .git/config und leert den Arbeitsbaum des Submoduls, stagt jedoch nichts und lässt .gitmodules unangetastet.
git rm path/to/good-ext-lib führt die versionierte Entfernung durch. Er löscht den gitlink – den Indexeintrag, der festhält, auf welchen Commit das Submodul festgelegt ist –, entfernt den Abschnitt des Submoduls aus .gitmodules, löscht das Verzeichnis im Arbeitsbaum und stagt alle diese Änderungen für den nächsten Commit.
Das eigentlich geklonte Repository hinter einem Submodul liegt unter .git/modules, hier .git/modules/path/to/good-ext-lib. Keiner der obigen Befehle löscht es; deshalb kann ein erneutes Hinzufügen eines Submoduls unter demselben Namen den zwischengespeicherten Klon wiederverwenden. Löschen Sie dieses Verzeichnis nur manuell, um Speicherplatz zurückzugewinnen oder einen vollständig neuen Klon zu erzwingen – und erst, nachdem das Entfernen committet wurde, denn damit wird die lokale Kopie endgültig verworfen.
Die Entfernung überprüfen und committen
Prüfen Sie vor dem Committen, was gestagt wurde: git status listet den gelöschten gitlink und die Änderung an .gitmodules auf, und git diff --cached zeigt dieselben Änderungen als Patch. Anschließend halten Sie das Entfernen wie jede andere Änderung mit git commit -m "Remove submodule good-ext-lib" fest.
Der Commit ist der einzige Schritt, den andere Klone sehen – er ist der Nachweis des Superprojekts, dass das Submodul entfernt wurde. Das Löschen übrig gebliebener Metadaten unter .git/modules ist rein lokale Aufräumarbeit und niemals Teil des Commits; Klone, die diese Änderung abrufen, hören automatisch auf, das Submodul zu verfolgen.