複数のリポジトリの使用 working-with-multiple-source-git-repos

Cloud Manager を操作する際に複数の Git リポジトリを管理する方法について説明します。

顧客の管理による Git リポジトリの同期 syncing-customer-managed-git-repositories

Cloud Manager の Git リポジトリを直接操作するのではなく、顧客が独自の Git リポジトリ(1 つまたは複数)を操作できます。このような場合、Cloud Manager の Git リポジトリを常に最新の状態に保つために、自動同期プロセスを設定する必要があります。

顧客の Git リポジトリがどこでホストされているかに応じて、GitHub アクションまたは継続的統合ソリューション(Jenkins など)を使用して、自動処理を設定できます。自動処理を導入すると、顧客が所有する Git リポジトリにプッシュするたびに、Cloud Manager の Git リポジトリに自動的に転送できます。

顧客が所有する単一 Git リポジトリの場合のこうした自動処理は簡単ですが、複数のリポジトリの場合に自動処理を設定するには、初期設定が必要になります。複数の Git リポジトリのコンテンツは、1 つの Cloud Manager Git リポジトリ内の異なるディレクトリにマッピングする必要があります。Cloud Manager の Git リポジトリは、ルートの Maven pom.xml を使用してプロビジョニングする必要があります。このファイルには、モジュールセクションに様々なサブプロジェクトが一覧表示されています。

以下は、顧客が所有する 2 つの Git リポジトリのサンプル pom.xml ファイルです。

  • 最初のプロジェクトは、project-a という名前のディレクトリに格納されます。
  • 2 番目のプロジェクトは、project-b という名前のディレクトリに格納されます。
<?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>

このようなルート pom.xml が、Cloud Manager の Git リポジトリのブランチにプッシュされます。次に、変更内容を Cloud Manager の Git リポジトリに自動的に転送するように、2 つのプロジェクトを設定する必要があります。

考えられる解決策は次のとおりです。

  1. GitHub アクションは、プロジェクト A のブランチへのプッシュでトリガーできます。
  2. このアクションは、プロジェクト A と Cloud Manager Git リポジトリをチェックアウトし、プロジェクト A のすべてのコンテンツを Cloud Manager の Git リポジトリのディレクトリ project-a にコピーします。
  3. その後、アクションは変更のコミットとプッシュを行います。

例えば、プロジェクト A のメインブランチに対する変更は、Cloud Manager の Git リポジトリのメインブランチに自動的にプッシュされます。プロジェクト A の dev ブランチへのプッシュが Cloud Manager の Git リポジトリの development ブランチにプッシュされるなど、ブランチ間でマッピングが行われる場合があります。同様の手順がプロジェクト B にも必要です。

分岐戦略とワークフローに応じて、異なるブランチに対して同期を設定できます。使用する Git リポジトリが GitHub アクションと類似した概念を提供しない場合は、Jenkins(またはそれに類似のもの)を介した統合も可能です。この場合、web フックが、処理を実行する Jenkins ジョブをトリガーします。

3 番目のソースまたはリポジトリを新しく追加するには、次の手順に従います。

  1. そのリポジトリからの変更を Cloud Manager の Git リポジトリにプッシュする GitHub アクションを、新しいリポジトリに追加します。
  2. このアクションを少なくとも 1 回実行して、プロジェクトコードが Cloud Manager の Git リポジトリにあることを確認します。
  3. Cloud Manager の Git リポジトリのルート Maven pom.xml に新しいディレクトリへの参照を追加します。

GitHub アクションの例 sample-github-action

このサンプル GitHub アクションは、メインブランチへのプッシュによってトリガーされた後、Cloud Manager の Git リポジトリのサブディレクトリにプッシュされます。Cloud Manager の Git リポジトリに接続してプッシュできるように、この GitHub アクションに MAIN_USERMAIN_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} ${MAIN_REPOSITORY} ${MAIN_BRANCH}
      # Move sub project
      - name: Move project to main project
        run: |
          rm -rf ${MAIN_BRANCH}/${PROJECT_DIR}
          mv sub ${MAIN_BRANCH}/${PROJECT_DIR}
      - name: Commit Changes
        run: |
          git -C ${MAIN_BRANCH} add -f ${PROJECT_DIR}
          git -C ${MAIN_BRANCH} commit -F ../commit.txt
          git -C ${MAIN_BRANCH} push

GitHub アクションは柔軟に使用することができます。Git リポジトリのブランチ間のマッピングを実行できるほか、個別の Git プロジェクトをメインプロジェクトのディレクトリレイアウトにマッピングすることもできます。

NOTE
サンプルスクリプトでは git add を使用してリポジトリを更新します。 この場合、削除が含まれていると仮定します。 Git のデフォルト設定によっては、これを git add --all に置き換える必要があります。

Jenkins ジョブの例 sample-jenkins-job

これは、Jenkins ジョブなどで使用できるサンプルスクリプトで、そのフローは次のとおりです。

  1. Git リポジトリの変更によってトリガーされます。
  2. そのプロジェクトまたはブランチの最新の状態を Jenkins ジョブがチェックアウトします。
  3. 次に、ジョブがこのスクリプトをトリガーします。
  4. このスクリプトは Cloud Manager の Git リポジトリをチェックアウトし、プロジェクトコードをサブディレクトリにコミットします。

Cloud Manager の Git リポジトリに接続してプッシュできるように、Jenkins ジョブに MAIN_USERMAIN_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 プロジェクトをメインプロジェクトのディレクトリレイアウトにマッピングすることもできます。

NOTE
サンプルスクリプトでは git add を使用してリポジトリを更新します。 この場合、削除が含まれていると仮定します。 Git のデフォルト設定によっては、これを git add --all に置き換える必要があります。
recommendation-more-help
fbcff2a9-b6fe-4574-b04a-21e75df764ab