複数ソース Git リポジトリーの操作 working-with-multiple-source-git-repos
Cloud Manager の Git リポジトリを直接操作するのではなく、独自の Git リポジトリ(1 つまたは複数)を操作する方法を説明します。
顧客が管理する Git リポジトリの同期 syncing-customer-managed-git-repositories
独自のリポジトリまたは複数のリポジトリを操作する場合は、Cloud Manager の Git リポジトリを常に最新の状態に保つために、自動同期プロセスを設定する必要があります。
Git リポジトリがホストされている場所に応じて、GitHub アクションまたは継続的統合ソリューション(Jenkins など)を使用して、自動処理を設定できます。自動化を導入すると、リポジトリにプッシュするたびに Cloud Manager の Git リポジトリに自動的に転送できます。
顧客が所有する単一の Git リポジトリに対する自動処理は簡単ですが、複数のリポジトリに対して自動処理を設定するには、より複雑な初期設定が必要になります。複数の Git リポジトリのコンテンツは、1 つの Cloud Manager の Git リポジトリ内の異なるディレクトリにマッピングする必要があります。Cloud Manager の Git リポジトリは、ルートの Maven pom.xml
を使用してプロビジョニングする必要があります。モジュールセクションに様々なサブプロジェクトが一覧表示されます。
顧客が所有する 2 つの Git リポジトリに対する pom.xml
のサンプルは次の通りです。1 つ目のプロジェクトは project-a
、2 つ目のプロジェクトは project-b
というディレクトリに配置されます。
<?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>
このようなルート pom.xml
が、Cloud Manager の Git リポジトリのブランチにプッシュされます。次に、変更内容を Cloud Manager の Git リポジトリに自動的に転送するように、2 つのプロジェクトを設定する必要があります。
例えば、プロジェクト A でブランチへのプッシュによって GitHub アクションをトリガーできます。このアクションは、プロジェクト A と Cloud Manager の Git リポジトリをチェックアウトし、プロジェクト A のすべてのコンテンツを Cloud Manager の Git リポジトリにある project-a
ディレクトリにコピーし、変更内容をコミットしてプッシュします。
例えば、プロジェクト A の main
ブランチに対する変更は、Cloud Manager の Git リポジトリの main
ブランチに自動的にプッシュされます。もちろん、プロジェクト A の dev
というブランチへのプッシュが、Cloud Manager の Git リポジトリにある development
ブランチにプッシュされるなど、ブランチ間でマッピングがおこなわれる場合があります。プロジェクト B にも同様の手順が必要です。
ブランチの方法とワークフローに応じて、異なるブランチに対して同期を設定できます。使用する Git リポジトリが GitHub アクションと類似した概念を提供しない場合は、Jenkins(またはそれに類似のもの)を介した統合も可能です。この場合、webhook が Jenkins ジョブをトリガーし、このジョブが動作します。
次の手順に従って、新しい(3 番目の)ソースまたはリポジトリーを追加します。
- 新しいリポジトリに、そのリポジトリからの変更を Cloud Manager の Git リポジトリにプッシュする新しい GitHub アクション追加します。
- このアクションを少なくとも 1 回実行して、プロジェクトコードが Cloud Manager の Git リポジトリにあることを確認します。
- Cloud Manager の Git リポジトリのルート Maven
pom.xml
に新しいディレクトリへの参照を追加します。
GitHub アクションの例 sample-github-action
これは main
ブランチへのプッシュでトリガーされたサンプル GitHub アクションで、Cloud Manager の Git リポジトリのサブディレクトリにプッシュします。Cloud Manager の Git リポジトリに接続してプッシュできるように、この GitHub アクションに MAIN_USER
と MAIN_PASSWORD
の 2 つのシークレットを提供する必要があります。
name: SYNC
env:
# Username/email used to commit to Cloud Manager's Git repository
USER_NAME: <NAME>
USER_EMAIL: <EMAIL>
# Directory within the Cloud Manager Git repository
PROJECT_DIR: project-a
# Cloud Manager's Git repository
MAIN_REPOSITORY: https://$MAIN_USER:$MAIN_PASSWORD@git.cloudmanager.adobe.com/<PATH>
# The branch in Cloud Manager's Git repository to push to
MAIN_BRANCH : <BRANCH_NAME>
# Only run on a push to this branch
on:
push:
branches: [ main ]
jobs:
build:
runs-on: ubuntu-latest
steps:
# Checkout this project into a sub folder
- uses: actions/checkout@v2
with:
path: sub
# Cleanup sub project
- name: Clean project
run: |
git -C sub log --format="%an : %s" -n 1 > commit.txt
rm -rf sub/.git
rm -rf sub/.github
# Set global git configuration
- name: Set git config
run: |
git config --global credential.helper cache
git config --global user.email ${USER_EMAIL}
git config --global user.name ${USER_NAME}
# Checkout the main project
- name: Checkout main project
run:
git clone -b ${MAIN_BRANCH} https://${{ secrets.PAT }}@github.com/${MAIN_REPOSITORY}.git main
# Move sub project
- name: Move project to main project
run: |
rm -rf main/${PROJECT_DIR}
mv sub main/${PROJECT_DIR}
- name: Commit Changes
run: |
git -C main add -f ${PROJECT_DIR}
git -C main commit -F ../commit.txt
git -C main push
上に示すように、GitHub アクションの使用は非常に柔軟です。Git リポジトリのブランチ間のマッピングや個別の Git プロジェクトをメインプロジェクトのディレクトリレイアウトにマッピングも実行できます。
git add
を使用します。Git のデフォルト設定に応じて、これを git add --all
に置き換える必要がある場合があります。Jenkins ジョブの例 sample-jenkins-job
これは、Jenkins ジョブなどで使用できるスクリプトの例です。Git リポジトリの変更によってトリガーされます。Jenkins ジョブは、そのプロジェクトまたはブランチの最新のステートをチェックアウトし、このスクリプトを実行します。
このスクリプトは Cloud Manager の Git リポジトリをチェックアウトし、プロジェクトコードをサブディレクトリにコミットします。
Cloud Manager の Git リポジトリに接続してプッシュできるように、Jenkins ジョブに MAIN_USER
と MAIN_PASSWORD
の 2 つのシークレットを提供する必要があります。
# Username/email used to commit to Cloud Manager's Git repository
export USER_NAME=<NAME>
export USER_EMAIL=<EMAIL>
# Directory within the Cloud Manager Git repository
export PROJECT_DIR=project-a
# Cloud Manager's Git repository
export MAIN_REPOSITORY=https://$MAIN_USER:$MAIN_PASSWORD@git.cloudmanager.adobe.com/<PATH>
# The branch in Cloud Manager's Git repository to push to
export MAIN_BRANCH=<BRANCH_NAME>
# clean up and init
rm -rf target
mkdir target
# mv project to sub folder
mkdir target/sub
for f in .* *
do
if [ "$f" != "." -a "$f" != ".." -a "$f" != "target" ]
then
mv "$f" target/sub
fi
done
cd target
# capture log and remove git info
cd sub
git log --format="%an : %s" -n 1 > ../commit.txt
rm -rf .git
rm -rf .github
cd ..
# checkout main repository
git clone -b $MAIN_BRANCH $MAIN_REPOSITORY main
cd main
# configure main repository
git config credential.helper cache
git config user.email $USER_EMAIL
git config user.name $USER_NAME
# update project in main
rm -rf $PROJECT_DIR
mv ../sub $PROJECT_DIR
# commit changes to main
git add -f $PROJECT_DIR
git commit -F ../commit.txt
git push
上に示すように、Jenkins ジョブの使用は非常に柔軟です。Git リポジトリのブランチ間のマッピングや個別の Git プロジェクトをメインプロジェクトのディレクトリレイアウトにマッピングも実行できます。
git add
を使用します。Git のデフォルト設定によっては、これを git add --all
に置き換える必要があります。