Przejdź do treści

Submoduły

Wyświetl jako Markdown Edytuj w GitHub Dokumentacja: bfe242f

Git submoduły osadzają jedno repozytorium wewnątrz drugiego. W drzewie nadrzędnym submoduł jest reprezentowany jako wpis gitlink (tryb 160000) wskazujący konkretny commit w repozytorium submodułu. URL submodułu i jego ścieżka są określone w pliku .gitmodules.

Pojęcia

W drzewie repozytorium nadrzędnego:

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

Wpis gitlink określa, który commit submodułu należy pobrać. Właściwe repozytorium submodułu znajduje się w .git/modules/<name>/.

SubmoduleManager

PHP
use Pitmaster\Submodule\SubmoduleManager;

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

Wyświetlanie submodułów

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";
    }
}

Obiekt wartości submodułu

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)

Parsowanie .gitmodules

Plik .gitmodules definiuje konfigurację submodułów:

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";
}

Parser obsługuje:

  • Nagłówki sekcji: [submodule "<name>"]
  • Pary klucz-wartość: path = ..., url = ..., branch = ...
  • Komentarze (wiersze zaczynające się od #)
  • Białe znaki i wcięcia

Pominięte są wpisy bez obu elementów: path i url. Wartości nie są pozbawiane cudzysłowów.

Wpisy gitlink to wpisy drzewa w trybie 160000. Wskazują commit (a nie drzewo ani blob) w repozytorium submodułu.

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

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

Wykrywanie TreeEntry

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

Inicjowanie submodułów

PHP
$manager->init();

Dla każdego submodułu zadeklarowanego w .gitmodules:

  1. Tworzy pusty katalog .git/modules/<name>/
  2. Tworzy katalog ścieżki submodułu, jeśli jeszcze nie istnieje
  3. Zapisuje submodule.<name>.active = true i submodule.<name>.url w .git/config

Nie pobiera ani nie pobiera do katalogu roboczego żadnych plików i nie zapisuje pliku .git submodułu.

Aktualizowanie submodułów

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

Dla każdego submodułu przypiętego w podanym drzewie update() kopiuje katalog git repozytorium źródłowego do .git/modules/<name>/, zastępuje pliki robocze submodułu plikami ze źródła, zapisuje plik .git wskazujący katalog modułu, ustawia core.worktree i odłącza HEAD przy przypiętym commicie.

Adres URL submodułu musi być ścieżką lokalną: bezwzględną albo względną względem drzewa roboczego repozytorium nadrzędnego (git rozwiązuje względne adresy URL względem remote URL repozytorium nadrzędnego). URL ze schematem (https://...) zgłasza RuntimeException('Submodule update currently supports only local paths: ...').

Po aktualizacji możesz otworzyć każdy submoduł jako osobne repozytorium:

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

Sprawdzanie przypiętych commitów

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

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

Metoda pinnedCommit() przechodzi przez hierarchię drzewa, aby znaleźć wpis gitlink pod podaną ścieżką, i zwraca hash docelowego commitu.

Stan submodułu

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";
}

Pola stanu:

  • name: nazwa submodułu
  • path: ścieżka w drzewie roboczym
  • expected: hash commitu przypiętego w drzewie nadrzędnym (null, jeśli go nie ma)
  • actual: bieżący HEAD submodułu (null, jeśli nie został zainicjowany)
  • dirty: true, gdy oba commity są znane i różnią się. Zmiany w drzewie roboczym submodułu nie są sprawdzane.

Struktura katalogów

Kod
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

Przebieg pracy z submodułami

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";