Zum Inhalt springen

Submodule

Als Markdown anzeigen Auf GitHub bearbeiten Dokumentation zu bfe242f

Git-Submodule betten ein Repository in ein anderes ein. Im Baum des übergeordneten Repositorys wird ein Submodule durch einen Gitlink-Eintrag (Modus 160000) dargestellt, der auf einen bestimmten Commit im Submodule-Repository zeigt. URL und der Pfad des Submodules werden in der Datei .gitmodules angegeben.

Konzepte

Im Baum des übergeordneten Repositorys:

Code
100644 blob abc123...  README.md
040000 tree def456...  src/
160000 commit 789012... lib/external    <-- gitlink entry (submodule)

Der Gitlink-Eintrag hält fest, welcher Commit des Submodules ausgecheckt werden soll. Das tatsächliche Submodule-Repository befindet sich in .git/modules/<name>/.

SubmoduleManager

PHP
use Pitmaster\Submodule\SubmoduleManager;

$manager = new SubmoduleManager(
    $repo->objectDatabase(),
    $repo->workDir(),
    $repo->gitDir(),
);

Submodule auflisten

PHP
$submodules = $manager->list();

foreach ($submodules as $sub) {
    echo "{$sub->name}: {$sub->url} at {$sub->path}\n";
    if ($sub->branch !== null) {
        echo "  tracks branch: {$sub->branch}\n";
    }
}

Submodule-Wertobjekt

PHP
use Pitmaster\Submodule\Submodule;

$sub->name;     // Submodule name (from .gitmodules section header)
$sub->path;     // Path in the working tree
$sub->url;      // Remote URL
$sub->branch;   // Tracked branch (nullable)

.gitmodules einlesen

Die Datei .gitmodules enthält die Submodule-Konfiguration:

Ini
[submodule "lib/external"]
    path = lib/external
    url = https://github.com/vendor/lib.git
    branch = main

[submodule "tools/helper"]
    path = tools/helper
    url = https://github.com/vendor/helper.git
PHP
$content = file_get_contents('.gitmodules');
$submodules = SubmoduleManager::parseGitmodules($content);

foreach ($submodules as $sub) {
    echo "{$sub->name} -> {$sub->url}\n";
}

Der Parser verarbeitet:

  • Abschnittsüberschriften: [submodule "<name>"]
  • Schlüssel-Wert-Paare: path = ..., url = ..., branch = ...
  • Kommentare (Zeilen, die mit # beginnen)
  • Leerraum und Einrückung

Einträge ohne path und url werden übersprungen. Werte werden nicht von Anführungszeichen befreit.

Gitlink-Einträge sind Baumeinträge mit dem Modus 160000. Sie verweisen auf einen Commit (nicht auf einen Baum oder Blob) im Submodule-Repository.

PHP
$tree = $repo->readObject($treeHash);

foreach ($tree->entries as $entry) {
    if ($entry->isGitlink()) {
        echo "Submodule at {$entry->name}: commit {$entry->hash->hex}\n";
    }
}

TreeEntry-Erkennung

PHP
$entry->isGitlink();  // true if mode is '160000'
$entry->mode;         // '160000'

Submodule initialisieren

PHP
$manager->init();

Für jedes in .gitmodules deklarierte Submodule geschieht Folgendes:

  1. Erstellt ein leeres Verzeichnis .git/modules/<name>/
  2. Erstellt das Verzeichnis für den Submodule-Pfad, falls es noch nicht existiert
  3. Speichert submodule.<name>.active = true und submodule.<name>.url in .git/config

Es werden keine Daten abgerufen oder ausgecheckt, und die Datei .git des Submodules wird nicht geschrieben.

Submodule aktualisieren

PHP
$manager->update($repo->head()->tree);

Für jedes im angegebenen Baum fixierte Submodul kopiert update() das Verzeichnis git des Quell-Repositorys nach .git/modules/<name>/, ersetzt die Arbeitsdateien des Submoduls durch die Dateien aus der Quelle, schreibt die .git-Datei mit Verweis auf das Modulverzeichnis, setzt core.worktree und löst HEAD beim fixierten Commit ab.

Das URL des Submodules muss ein lokaler Pfad sein: absolut oder relativ zum Arbeitsverzeichnis des übergeordneten Repositorys (git löst relative URLs stattdessen relativ zur Remote-URL des übergeordneten Repositorys auf). Ein URL mit einem Schema (https://...) löst RuntimeException('Submodule update currently supports only local paths: ...') aus.

Nach einer Aktualisierung kannst du jedes Submodule als eigenes Repository öffnen:

PHP
$subRepo = Pitmaster::open($repo->workDir() . '/lib/external');

Fixierte Commits prüfen

PHP
$headCommit = $repo->head();
$pinnedId = $manager->pinnedCommit('lib/external', $headCommit->tree);

if ($pinnedId !== null) {
    echo "lib/external is pinned to commit {$pinnedId->hex}\n";
}

Die Methode pinnedCommit() durchläuft die Baumhierarchie, sucht den Gitlink-Eintrag am angegebenen Pfad und gibt den Hash des Ziel-Commits zurück.

Submodule-Status

PHP
$headCommit = $repo->head();
$statuses = $manager->status($headCommit->tree);

foreach ($statuses as $status) {
    $expected = $status['expected'] ?? 'not pinned';
    $actual = $status['actual'] ?? 'not initialized';
    $dirty = $status['dirty'] ? ' (dirty)' : '';

    echo "{$status['name']}: expected={$expected}, actual={$actual}{$dirty}\n";
}

Statusfelder:

  • name: Name des Submodules
  • path: Pfad im Arbeitsverzeichnis
  • expected: Hash des im übergeordneten Baum fixierten Commits (null, falls nicht vorhanden)
  • actual: aktueller HEAD des Submodules (null, wenn nicht initialisiert)
  • dirty: true, wenn beide Commits bekannt und unterschiedlich sind. Änderungen im Arbeitsverzeichnis des Submodules werden nicht geprüft.

Verzeichnisstruktur

Code
project/
  .git/
    modules/
      lib/
        external/          # Submodule's actual git directory (.git/modules/<name>)
        HEAD
        objects/
        refs/
        ...
  .gitmodules              # Submodule declarations
  lib/
    external/
      .git                 # File: "gitdir: ../../.git/modules/lib/external"
      src/
      README.md
  src/
  README.md

Submodule-Arbeitsablauf

PHP
// 1. Open the parent repo
$repo = Pitmaster::open('/path/to/project');

// 2. List submodules
$manager = new SubmoduleManager(
    $repo->objectDatabase(),
    $repo->workDir(),
    $repo->gitDir(),
);

$submodules = $manager->list();

// 3. Populate the submodules pinned at HEAD (local source paths only)
$manager->update($repo->head()->tree);

// 4. Check status
$statuses = $manager->status($repo->head()->tree);

// 5. Open a submodule as its own repo
$subRepo = Pitmaster::open($repo->workDir() . '/lib/external');
$subHead = $subRepo->head();
echo "Submodule HEAD: {$subHead->id->hex}\n";