Gå til indhold

Undermoduler

Vis som Markdown Rediger på GitHub Dokumentation hos bfe242f

Git undermoduler indlejrer ét repository i et andet. Et undermodul repræsenteres i parent-træet som en gitlink-post (tilstand 160000), der peger på en bestemt commit i undermodul-repositoriet. Undermodulets URL og sti angives i filen .gitmodules.

Begreber

I parent-repositoriets træ:

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

Gitlink-posten registrerer, hvilken commit af undermodulet der skal checkes ud. Selve undermodul-repositoriet ligger i .git/modules/<name>/.

SubmoduleManager

PHP
use Pitmaster\Submodule\SubmoduleManager;

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

Vis undermoduler

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

Undermodul-værdiobjekt

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)

Fortolkning af .gitmodules

Filen .gitmodules erklærer undermodulkonfiguration:

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

Fortolkeren håndterer:

  • Sektionsoverskrifter: [submodule "<name>"]
  • Nøgle-værdi-par: path = ..., url = ..., branch = ...
  • Kommentarer (linjer, der starter med #)
  • Mellemrum og indrykning

Poster uden både path og url springes over. Værdier fjernes ikke fra anførselstegn.

Gitlink-poster er træposter med tilstanden 160000. De peger på en commit (ikke et træ eller en blob) i undermodul-repositoriet.

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

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

Registrering af TreeEntry

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

Initialisering af undermoduler

PHP
$manager->init();

For hvert undermodul angivet i .gitmodules gør dette følgende:

  1. Opretter en tom .git/modules/<name>/-mappe
  2. Opretter undermodulets stimap­pe, hvis den ikke findes
  3. Registrerer submodule.<name>.active = true og submodule.<name>.url i .git/config

Den henter eller checker ikke noget ud, og den skriver ikke undermodulets fil .git.

Opdatering af undermoduler

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

For hvert undermodul, der er fastlåst i det angivne træ, kopierer update() kilde-repositoriets git-mappe til .git/modules/<name>/, erstatter undermodulets arbejdsfiler med kildens, skriver filen .git, der peger på modulmappen, indstiller core.worktree og frakobler HEAD ved den fastlåste commit.

Undermodulets URL skal være en lokal sti: absolut eller relativ til parentens arbejdsttræ (git løser i stedet relative URL'er i forhold til parentens remote-URL). En URL med et skema (https://...) kaster RuntimeException('Submodule update currently supports only local paths: ...').

Efter en opdatering kan du åbne hvert undermodul som et separat repository:

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

Kontrol af fastlåste commits

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

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

Metoden pinnedCommit() gennemløber træhierarkiet for at finde gitlink-posten ved den angivne sti og returnerer dens mål-commit-hash.

Undermodulstatus

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

Statusfelter:

  • name: undermodulets navn
  • path: sti i arbejdstræet
  • expected: commit-hash fastlåst i parent-træet (null, hvis den ikke findes)
  • actual: undermodulets aktuelle HEAD (null, hvis det ikke er initialiseret)
  • dirty: true, når begge commits kendes og er forskellige. Ændringer i undermodulets arbejdstræ kontrolleres ikke.

Mappestruktur

Kode
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

Arbejdsgang for undermoduler

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