Подмодули Git

Подмодули Git позволяют сохранить репозиторий Git в качестве подкаталога другого репозитория Git. Подмодуль Git — это просто ссылка на другой репозиторий в определенный момент времени. Благодаря подмодулям в репозиторий Git можно включить историю версий внешнего кода и отслеживать ее.

Что такое подмодуль git?

Часто репозиторий кода зависит от внешнего кода, который можно включить в репозиторий различными способами. Вы можете напрямую скопировать и вставить внешний код в главный репозиторий, но при этом потеряете доступ ко всем вышестоящим изменениям во внешнем репозитории. Можно пойти другим путем и воспользоваться системой управления пакетами для конкретного языка, такой как Ruby Gems или NPM, однако в этом случае придется заниматься установкой и управлением версиями во всех местах развертывания исходного кода. Оба предложенных метода не позволяют отслеживать правки и изменения во внешнем репозитории.

Подмодуль Git — это запись в хост-репозитории Git, которая указывает на конкретный коммит в другом внешнем репозитории. Подмодули очень статичны: с их помощью можно отслеживать определенные коммиты, но не ветки или ссылки Git. Кроме того, они не обновляются автоматически при обновлении хост-репозитория. Когда вы добавляете подмодуль в репозиторий, создается новый файл .gitmodules, в котором содержатся метаданные о сопоставлении URL-адреса проекта подмодуля с локальным каталогом. Если хост-репозиторий содержит несколько подмодулей, в файл .gitmodules будет включена отдельная запись для каждого подмодуля.

Когда следует использовать подмодуль git?

Подмодули git имеет смысл использовать, если необходимо обеспечить строгое управление версиями внешних зависимостей. Ниже приводится несколько ситуаций, в которых использование подмодулей git наиболее уместно.

•  Внешний компонент или подпроект изменяются слишком быстро, или предстоящие изменения могут нарушить работу API. В этом случае можно заблокировать код для конкретного коммита в целях безопасности.

•  У вас есть компонент, который обновляется довольно редко, и вы хотите отслеживать его в качестве зависимости поставщика.

•  Вы делегируете выполнение части проекта другим лицам и хотите интегрировать их работу в определенное время или в конкретном релизе. Это полезно только в том случае, когда обновления происходят не слишком часто.

Основные команды для работы с подмодулями git

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

С помощью команды git submodule add можно добавить новый подмодуль в существующий репозиторий. Ниже приводится пример, в котором создается пустой репозиторий и изучаются подмодули git.

1$ mkdir git-submodule-demo
2$ cd git-submodule-demo/
3$ git init
4Initialized empty Git repository in /Users/atlassian/git-submodule-demo/.git/

Эта последовательность команд создает новый каталог git-submodule-demo, выполняет переход в этот каталог и инициализирует его в качестве нового репозитория. Теперь добавим подмодуль в этот новый репозиторий.

1$ git submodule add https://bitbucket.org/jaredw/awesomelibrary
2Cloning into '/Users/atlassian/git-submodule-demo/awesomelibrary'...
3remote: Counting objects: 8, done.
4remote: Compressing objects: 100% (6/6), done.
5remote: Total 8 (delta 1), reused 0 (delta 0)
6Unpacking objects: 100% (8/8), done.

Команда git submodule add принимает в качестве параметра URL-адрес, который указывает на репозиторий git. Мы добавили подмодуль awesomelibrary, который система Git сразу же клонирует. Теперь проверим текущее состояние репозитория с помощью команды git status…

1$ git status
2On branch main
3
4No commits yet
5
6Changes to be committed:
7  (use "git rm --cached <file>..." to unstage)
8
9 new file:   .gitmodules
10 new file:   awesomelibrary

В репозитории появилось два новых элемента: файл .gitmodules и каталог awesomelibrary. Если изучить содержимое файла .gitmodules, можно увидеть информацию о сопоставлении для нового подмодуля.

1[submodule "awesomelibrary"]
2 path = awesomelibrary
3 url = https://bitbucket.org/jaredw/awesomelibrary

1$ git add .gitmodules awesomelibrary/
2$ git commit -m "added submodule"
3[main (root-commit) d5002d0] added submodule
4 2 files changed, 4 insertions(+)
5 create mode 100644 .gitmodules
6 create mode 160000 awesomelibrary

Клонирование подмодулей Git

1git clone /url/to/repo/with/submodules
2git submodule init
3git submodule update

Команда git submodule init

По умолчанию команда git submodule init копирует информацию о сопоставлении из файла .gitmodules в локальный файл ./.git/config. Это может показаться избыточным и вызвать сомнения в полезности команды git submodule init. Однако команда git submodule init имеет расширенные функциональные возможности. В частности, она принимает заданный в явном виде список имен модулей. В этом случае рабочий процесс активирует только определенные подмодули, необходимые для работы с репозиторием. Это может быть полезно, если в репозитории много подмодулей, но для текущей работы не требуется извлекать их все.

Рабочие процессы подмодулей

После надлежащей инициализации и обновления подмодулей в родительском репозитории их можно использовать точно так же, как автономные репозитории. Это означает, что у подмодулей есть собственные ветки и история. После того как вы внесли изменения в подмодуль, важно опубликовать их и обновить ссылку на подмодуль в родительском репозитории. Продолжим работу с подмодулем awesomelibrary и внесем некоторые изменения:

1$ cd awesomelibrary/
2$ git checkout -b new_awesome
3Switched to a new branch 'new_awesome'
4$ echo "new awesome file" > new_awesome.txt
5$ git status
6On branch new_awesome
7Untracked files:
8  (use "git add <file>..." to include in what will be committed)
9
10 new_awesome.txt
11
12nothing added to commit but untracked files present (use "git add" to track)
13$ git add new_awesome.txt
14$ git commit -m "added new awesome textfile"
15[new_awesome 0567ce8] added new awesome textfile
16 1 file changed, 1 insertion(+)
17 create mode 100644 new_awesome.txt
18$ git branch
19  main
20* new_awesome

Мы перешли в каталог подмодуля awesomelibrary, затем создали новый текстовый файл new_awesome.txt с некоторым содержимым, добавили этот файл в подмодуль и выполнили коммит. Теперь переключим каталог, чтобы вернуться в родительский репозиторий, и проверим текущее состояние родительского репозитория.

1$ cd ..
2$ git status
3On branch main
4Changes not staged for commit:
5  (use "git add <file>..." to update what will be committed)
6  (use "git checkout -- <file>..." to discard changes in working directory)
7
8 modified:   awesomelibrary (new commits)
9
10no changes added to commit (use "git add" and/or "git commit -a")

Выполнив команду git status, мы увидим, что родительскому репозиторию известно о новых коммитах в подмодуле awesomelibrary. При этом речь не идет о деталях обновлений, поскольку за них отвечают репозитории подмодулей. Родительский репозиторий занимается только связью подмодуля с коммитом. Теперь можно снова обновить родительский репозиторий, выполнив команды git add и git commit для подмодуля, чтобы подытожить работу с локальным содержимым. Если вы работаете в командной среде, важно после этого выполнить команду git push для отправки обновлений подмодуля и родительского репозитория.

При работе с подмодулями часто возникают ошибки и путаница из-за того, что разработчики забывают отправить обновления для удаленных пользователей. Если взглянуть на работу с подмодулем awesomelibrary, которую мы только что проделали, можно увидеть, что мы отправили обновления только в родительский репозиторий. Если другой разработчик захочет получить последнюю версию родительского репозитория, в котором будет указатель на коммит awesomelibrary, он не сможет получить изменения, потому что мы забыли отправить подмодуль. Это приведет к сбою в работе локального репозитория удаленного разработчика. Чтобы избежать такого сценария, всегда отправляйте подмодуль и родительский репозиторий командой push после выполнения коммитов.

Заключение

Благодаря подмодулям можно эффективно применять git в качестве внешнего инструмента управления зависимостями. Однако внедрение подобной продвинутой возможности может потребовать обучения участников команды, поэтому взвесьте все плюсы и минусы подмодулей git, прежде чем их использовать.