Utilisation de plusieurs référentiels working-with-multiple-source-git-repos

Découvrez comment gérer plusieurs référentiels Git lorsque vous utilisez Cloud Manager.

Synchronisation des référentiels Git privés syncing-customer-managed-git-repositories

Au lieu de travailler directement avec le référentiel Git de Cloud Manager, les clients peuvent travailler avec leur propre référentiel Git privéou avec plusieurs référentiels Git. Dans ce cas, configurez un processus de synchronisation automatisée pour vous assurer que le référentiel Git dans Cloud Manager est toujours à jour.

Selon l’emplacement d’hébergement du référentiel Git du client, une action GitHub ou une solution d’intégration continue telle que Jenkins peut être utilisée pour configurer l’automatisation. Une fois l’automatisation en place, chaque notification push vers un référentiel Git détenu par le client peut être automatiquement transférée vers le référentiel Git Cloud Manager.

Bien qu’une telle automatisation pour un seul référentiel Git détenu par le client soit simple, la configuration pour plusieurs référentiels nécessite une configuration initiale. Le contenu de plusieurs référentiels Git doit être mappé à différents répertoires dans le référentiel Git Cloud Manager unique. Le référentiel Git Cloud Manager doit être configuré avec un Maven racine pom.xml, répertoriant les différents sous-projets dans la section modules.

Voici un exemple de fichier pom.xml pour deux référentiels Git détenus par le client.

  • Le premier projet est placé dans le répertoire nommé project-a.
  • Le second projet est placé dans le répertoire nommé 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>

Ce fichier pom.xml racine est transmis vers une branche du référentiel Git de Cloud Manager. Ensuite, les deux projets doivent être configurés pour transférer automatiquement les modifications vers le référentiel Git de Cloud Manager.

Une solution possible serait la suivante.

  1. Déclenchez une action GitHub en la poussant vers une branche du projet A.
  2. L’action extrait le projet A et le référentiel Git de Cloud Manager. Ensuite, il copie tous les contenus du projet A dans le répertoire project-a du référentiel Git Cloud Manager.
  3. Ensuite, l’action engage-pousse la modification.

Par exemple, une modification apportée à la branche principale du projet A est automatiquement transmise à la branche principale du référentiel Git Cloud Manager. Il peut y avoir un mappage entre les branches, par exemple une notification push vers une branche nommée dev dans le projet A, qui est transmise à une branche nommée development dans le référentiel Git de Cloud Manager. Des étapes similaires sont requises pour le projet B.

Selon les workflows et la stratégie d’embranchement, il est possible de configurer la synchronisation pour différentes branches. Si le référentiel Git utilisé ne propose pas de concept similaire aux actions GitHub, une intégration via Jenkins (ou un outil similaire) est également possible. Dans ce cas, un webhook déclenche une tâche Jenkins qui effectue la tâche.

Suivez ces étapes pour ajouter une nouvelle source ou un troisième référentiel.

  1. Ajoutez une action GitHub au nouveau référentiel, qui envoie les modifications de ce référentiel vers le référentiel Git de Cloud Manager.
  2. Effectuez cette action au moins une fois pour vous assurer que le code du projet se trouve dans le référentiel Git de Cloud Manager.
  3. Dans le référentiel Git Cloud Manager, ajoutez une référence au nouveau répertoire dans le Maven racine pom.xml.

Exemple d’action GitHub sample-github-action

Vous trouverez ci-dessous un exemple d’action GitHub déclenchée par une notification push vers la branche principale. Ensuite, placez-vous dans un sous-répertoire du référentiel Git de Cloud Manager. Les actions GitHub doivent comporter deux secrets, MAIN_USER et MAIN_PASSWORD, pour se connecter et effectuer des transmissions de type push vers le référentiel Git de Cloud Manager.

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

L’utilisation d’une action GitHub est flexible. Tout mappage entre les branches des référentiels Git peut être effectué, de même que tout mappage des projets Git distincts dans la disposition des répertoires du projet principal.

NOTE
L’exemple de script utilise git add pour mettre à jour le référentiel. Le script suppose que les suppressions sont incluses. Selon la configuration par défaut de Git, il doit être remplacé par git add --all.

Exemple de traitement Jenkins sample-jenkins-job

Voici un exemple de script pouvant être utilisé dans une tâche Jenkins ou une tâche similaire et présentant le flux suivant :

  1. Elle est déclenchée par une modification dans un référentiel Git.
  2. Le traitement Jenkins extrait le dernier état de ce projet ou de cette branche.
  3. Le traitement déclenche ensuite ce script.
  4. Ce script extrait ensuite le référentiel Git de Cloud Manager et valide le code du projet dans un sous-répertoire.

La tâche Jenkins doit comporter deux secrets, MAIN_USER et MAIN_PASSWORD, pour se connecter et effectuer des transmissions de type push vers le référentiel Git de Cloud Manager.

# 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

L’utilisation d’une tâche Jenkins est flexible. Tout mappage entre les branches des référentiels Git peut être effectué, de même que tout mappage des projets Git distincts dans la disposition des répertoires du projet principal.

NOTE
L’exemple de script utilise git add pour mettre à jour le référentiel. Le script suppose que les suppressions sont incluses. Selon la configuration par défaut de Git, il doit être remplacé par git add --all.
recommendation-more-help
fbcff2a9-b6fe-4574-b04a-21e75df764ab