Към съдържанието

Подмодули

Преглед като Markdown Редактиране в GitHub Документация за bfe242f

Git Подмодулите вграждат едно хранилище в друго. В дървото на родителското хранилище подмодулът е представен като запис gitlink (режим 160000), който сочи към конкретен commit в хранилището на подмодула. URL и пътят на подмодула са декларирани във файла .gitmodules.

Основни понятия

В дървото на родителското хранилище:

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

Записът gitlink указва кой commit на подмодула трябва да бъде изтеглен. Самото хранилище на подмодула се намира в .git/modules/<name>/.

SubmoduleManager

PHP
use Pitmaster\Submodule\SubmoduleManager;

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

Изброяване на подмодулите

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

Обект със стойност на подмодул

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

Файлът .gitmodules декларира конфигурацията на подмодулите:

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

Парсерът обработва:

  • Заглавки на секции: [submodule "<name>"]
  • Ключове и стойности: path = ..., url = ..., branch = ...
  • Коментари (редове, започващи с #)
  • Интервали и отстъпи

Записите без едновременно path и url се пропускат. Стойностите не се премахват от кавичките.

Записите gitlink са записи в дървото с режим 160000. Те сочат към commit (а не към дърво или blob) в хранилището на подмодула.

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

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

Откриване на TreeEntry

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

Инициализиране на подмодули

PHP
$manager->init();

За всеки подмодул, деклариран в .gitmodules:

  1. Създава празна директория .git/modules/<name>/
  2. Създава директорията за пътя на подмодула, ако тя не съществува
  3. Записва submodule.<name>.active = true и submodule.<name>.url в .git/config

Това не изтегля и не извлича нищо, нито записва файла .git на подмодула.

Обновяване на подмодули

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

За всеки подмодул, фиксиран в зададеното дърво, update() копира git директорията на изходното хранилище в .git/modules/<name>/, заменя работните файлове на подмодула с тези от източника, записва файла .git, сочещ към директорията на модула, задава core.worktree и отделя HEAD при фиксирания commit.

URL на подмодула трябва да е локален път: абсолютен или относителен спрямо работното дърво на родителя (git разрешава относителните URL адреси спрямо отдалечения URL на родителя). URL със схема (https://...) генерира RuntimeException('Submodule update currently supports only local paths: ...').

След обновяването можете да отворите всеки подмодул като отделно хранилище:

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

Проверка на фиксираните commit-и

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

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

Методът pinnedCommit() обхожда йерархията на дървото, за да намери записа gitlink по зададения път и да върне целевия хеш на commit.

Състояние на подмодулите

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

Полета за състоянието:

  • name: име на подмодула
  • path: път в работното дърво
  • expected: хеш на commit, фиксиран в родителското дърво (null, ако липсва)
  • actual: текущият HEAD на подмодула (null, ако не е инициализиран)
  • dirty: true, когато и двата commit-а са известни и се различават. Промените в работното дърво на подмодула не се проверяват.

Структура на директориите

Код
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

Работен процес с подмодули

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