複数ソース Git リポジトリの操作 working-with-multiple-source-git-repos

Cloud Manager の Git リポジトリを直接操作するのではなく、独自の Git リポジトリまたは複数の Git リポジトリを操作する方法について説明します。

顧客の管理による 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(またはそれに類似のもの)を介した統合も可能です。この場合、web フックが、処理を実行する Jenkins ジョブをトリガーします。

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

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

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

main ブランチへのプッシュにより、この 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} 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 プロジェクトをメインプロジェクトのディレクトリレイアウトにマッピングすることもできます。

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

Jenkins ジョブの例 sample-jenkins-job

このスクリプトは、Jenkins ジョブまたは同種のジョブで使用できる例です。Git リポジトリの変更によってトリガーされます。Jenkins ジョブは、そのプロジェクトまたはブランチの最新のステートをチェックアウトし、このスクリプトをトリガーします。

今度は、このスクリプトは Cloud Manager の Git リポジトリをチェックアウトし、プロジェクトコードをサブディレクトリにコミットします。

Cloud Manager の Git リポジトリーに接続してプッシュできるようにするには、Jenkins ジョブに MAIN_USER と sMAIN_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 addgit add --all に置き換える必要があります。
recommendation-more-help
c6cdc82b-cee9-48e0-a6ee-48149d5e72c3