Adobe リポジトリに対する Git サブモジュールのサポート
- 適用対象：
- Experience Manager as a Cloud Service
- トピック：
- Cloud Manager
- 開発
作成対象：
- 管理者
- 開発者
Git サブモジュールを使用すると、ビルド時に Git リポジトリ間で複数のブランチのコンテンツを結合できます。
Cloud Manager のビルドプロセスを実行すると、パイプラインのリポジトリが複製され、分岐がチェックアウトされます。.gitmodules ファイルが分岐のルートディレクトリに存在する場合、対応するコマンドが実行されます。
次のコマンドは、各サブモジュールを適切なディレクトリにチェックアウトします。
$ git submodule update --init
この手法は、複数のソース Git リポジトリの操作で説明しているソリューションの代わりになります。Git サブモジュールに慣れており、外部マージプロセスの管理を望まない組織に最適です。
例えば、3 つのリポジトリがあるとします。各リポジトリには、main という名前の分岐が 1 つ含まれています。プライマリリポジトリ（パイプラインで設定されたもの）の main 分岐には、他の 2 つのリポジトリに含まれるプロジェクトを宣言している pom.xml ファイルがあります。
<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="https://maven.apache.org/POM/4.0.0" xmlns:xsi="https://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="https://maven.apache.org/POM/4.0.0 https://maven.apache.org/maven-v4_0_0.xsd">
<modelVersion>4.0.0</modelVersion>
<groupId>customer.group.id</groupId>
<artifactId>customer-reactor</artifactId>
<version>0.0.1-SNAPSHOT</version>
<packaging>pom</packaging>
<modules>
<module>project-a</module>
<module>project-b</module>
</modules>
</project>
次に、他の 2 つのリポジトリー用のサブモジュールを追加します。
$ git submodule add -b main https://git.cloudmanager.adobe.com/ProgramName/projectA/ project-a
$ git submodule add -b main https://git.cloudmanager.adobe.com/ProgramName/projectB/ project-b
その結果、.gitmodules ファイルの内容は次のようになります。
[submodule "project-a"]
path = project-a
url = https://git.cloudmanager.adobe.com/ProgramName/projectA/
branch = main
[submodule "project-b"]
path = project-b
url = https://git.cloudmanager.adobe.com/ProgramName/projectB/
branch = main
Git サブモジュールについて詳しくは、Git リファレンスマニュアルも参照してください。
使用上のメモ
-
Git の URL は、前述の節で説明した構文に正確に一致している必要があります。
-
分岐のルートにあるサブモジュールのみがサポートされます。
-
セキュリティ上の理由から、Git の URL に資格情報を埋め込まないでください。
-
特に必要がない限り、アドビでは、以下を実行してシャローサブモジュールを使用することをお勧めします。
各サブモジュールのgit config -f .gitmodules submodule.<submodule path>.shallow true。 -
Git サブモジュール参照は、特定の Git コミットに保存されます。その結果、サブモジュールリポジトリに対して変更を加えた場合は、参照されるコミットを更新する必要があります。
例えば、以下を使用します。git submodule update --remote
プライベートリポジトリに対する Git サブモジュールのサポート
プライベートリポジトリでの Git サブモジュールのサポートは、通常、Adobe リポジトリでの使用と同様です。
ただし、pom.xml ファイルを設定して git submodule コマンドを実行した後、Cloud Manager がサブモジュール設定を認識できるように、集積リポジトリのルートディレクトリに .gitmodules ファイルを追加する必要があります。
使用上のメモ
- サブモジュール Git の URL は、HTTPS 形式または SSH 形式にすることができますが、GitHub.com リポジトリを指す必要があります。Adobe リポジトリサブモジュールを GitHub 集積リポジトリに追加すること、またはその逆はサポートされていません。
- GitHub サブモジュールには、Adobe GitHub アプリからアクセスできる必要があります。
- また、アドビが管理するリポジトリで Git サブモジュールを使用する場合の制限事項も適用されます。