Unterstützung von Git-Untermodulen für Adobe-Repositorys git-submodule-support
Git-Untermodule können verwendet werden, um zum Build-Zeitpunkt den Inhalt mehrerer Verzweigungen über Git-Repositorys hinweg zusammenzuführen.
Wenn der Build-Prozess von Cloud Manager ausgeführt wird, klont er zunächst das Repository der Pipeline und prüft dann die konfigurierte Verzweigung. Wenn die Verzweigung eine .gitmodules-Datei im Stammverzeichnis enthält, wird der Befehl ausgeführt.
$ git submodule update --init
Dadurch wird jedes Untermodul im entsprechenden Verzeichnis geprüft. Diese Technik ist eine potenzielle Alternative zur Arbeit mit mehreren Quell-Git-Repositorys für Organisationen, die mit der Verwendung von Git-Untermodulen vertraut sind und keinen externen Zusammenführungsprozess verwalten möchten.
Angenommen, es gibt drei Repositorys, die jeweils eine einzige Verzweigung mit dem Namen main enthalten. Im „primären“ Repository, d. h. dem in den Pipelines konfigurierten, verfügt die Verzweigung main über eine Datei pom.xml, in der die in den beiden anderen Repositorys enthaltenen Projekte deklariert werden.
<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://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>
Anschließend fügen Sie Untermodule für die beiden anderen Repositorys hinzu:
$ 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
Die Ergebnisse in der Datei .gitmodules sehen wie folgt aus:
[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
Weitere Informationen zu Git-Untermodulen finden Sie im Git-Referenzhandbuch .
Einschränkungen limitations
Beachten Sie bei der Verwendung von Git-Untermodulen Folgendes:
- Die Git-URL muss sich genau an die oben beschriebene Syntax halten.
- Betten Sie aus Sicherheitsgründen keine Anmeldeinformationen in diese URLs ein.
- Es werden nur Untermodule im Stammverzeichnis der Verzweigung unterstützt.
- Für bestimmte Git-Commits werden Git-Untermodulverweise gespeichert. Wenn also Änderungen am Untermodul-Repository vorgenommen werden, muss der referenzierte Commit aktualisiert werden. Zum Beispiel mit
git submodule update --remote - Sofern nicht anders erforderlich, empfiehlt Adobe, „flache“ Untermodule zu verwenden, indem Sie für jedes Untermodul
git config -f .gitmodules submodule.<submodule path>.shallow trueausführen.
Unterstützung von Git-Untermodulen für private Repositorys private-repositories
Die Unterstützung für Git-Untermodule bei Verwendung von privaten Repositorys ist weitgehend dieselbe wie bei Verwendung von Adobe-Repositorys.
Nachdem Sie Ihre Datei pom.xml eingerichtet haben und die git submodule-Befehle ausgeführt werden, müssen Sie jedoch eine .gitmodules-Datei zum Stammverzeichnis des Aggregator-Repositorys hinzufügen, damit Cloud Manager die Einrichtung des Untermoduls erkennt.
Einschränkungen und Empfehlungen limitations-recommendations-private-repos
Beachten Sie bei der Verwendung von Git-Untermodulen mit privaten Repositorys die folgenden Einschränkungen.
- Die Git-URLs für die Untermodule können entweder im HTTPS- oder im SSH-Format vorliegen, müssen jedoch mit einem Github.com-Repository verknüpft sein. Das Hinzufügen eines Adobe-Repository-Untermoduls zu einem GitHub-Aggregator-Repository oder umgekehrt funktioniert nicht.
- Die GitHub-Untermodule müssen für die Adobe-GitHub-App zugänglich sein.
- Die Einschränkungen bei der Verwendung von Git-Untermodulen mit von Adobe verwalteten Repositorys gelten ebenfalls.