Working with Multiple Source Git Repositories working-with-multiple-source-git-repos

Instead of directly working with Cloud Manager’s git repository, learn how you can work with your own git repository or multiple git repositories.

Syncing Customer-Managed Git Repositories syncing-customer-managed-git-repositories

If you wish to work with your own repository or repositories, an automated synchronization process should be set up to ensure that Cloud Manager’s git repository is always kept up-to-date.

Depending on where your git repository is hosted, a GitHub action or a continuous integration solution like Jenkins could be used to setup the automation. With an automation in place, every push to your own repository can be automatically forwarded to Cloud Manager’s git repository.

While such an automation for a single customer-owned git repository is straightforward, configuring this up for multiple repositories requires a more involved initial setup. The contents from multiple git repositories need to be mapped to different directories within a single Cloud Manager’s git repository. Cloud Manager’s git repository needs to be provisioned with a root Maven pom.xml, listing the different sub projects in the modules section

Below is a sample pom.xml for two customer-owned git repositories. The first project will be put into the directory named project-a, the second project is put into the directory named 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>

Such a root pom.xml is pushed to a branch in Cloud Manager’s git repository. Then the two projects need to be set up to automatically forward changes to Cloud Manager’s git repository.

For example, a GitHub action can be triggered by a push to a branch in project A. The action will checkout project A and the Cloud Manager git repository and copy all contents from project A to the directory project-a in Cloud Manager’s git repository and then commit-push the change.

For example, a change on the main branch in project A is automatically pushed to the main branch in Cloud Manager’s git repository. Of course, there could be a mapping between branches like a push to a branch named dev in project A is pushed to a branch named development in Cloud Manager’s git repository. Similar steps are required for Project B.

Depending on the branching strategy and workflows, the syncing can be configured for different branches. If the used git repository does not provide a concept similar to GitHub actions, an integration via Jenkins (or similar) is possible as well. In this case a webhook triggers a Jenkins job which does the work.

Follow the steps below to add a new (third) source or repository:

Sample GitHub Action sample-github-action

This is a sample GitHub action triggered by a push to the main branch and then pushing into a sub directory of Cloud Manager’s git repository. The GitHub actions needs to be provided with two secrets, MAIN_USER and MAIN_PASSWORD, to be able to connect and push to Cloud Manager’s git repository.

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

As shown above, using a GitHub action is very flexible. Any mapping between branches of the git repositories can be performed as well as any mapping of the separate git projects into the directory layout of the main project.

Sample Jenkins Job sample-jenkins-job

This is a sample script that can be used in a Jenkins job or similar. It gets triggered by a change in a git repository. The Jenkins job checks out the latest state of that project or branch and then triggers this script.

This script in turn checks out Cloud Manager’s git repository and commits the project code to a subdirectory.

The Jenkins job needs to be provided with two secrets, MAIN_USER and MAIN_PASSWORD, to be able to connect and push to Cloud Manager’s git repository.

# 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

As shown above, using a Jenkins job is very flexible. Any mapping between branches of the git repositories can be performed as well as any mapping of the separate git projects into the directory layout of the main project.