Usando vários repositórios

Saiba como gerenciar vários repositórios git ao trabalhar com o Cloud Manager.

Sincronizando Repositórios Git Gerenciados pelo Cliente

Em vez de trabalhar diretamente com o repositório Git do Cloud Manager, os clientes podem trabalhar com seu próprio repositório git ou vários repositórios git próprios. Nesses casos, um processo de sincronização automatizada deve ser configurado para garantir que o repositório Git do Cloud Manager seja sempre atualizado.

Dependendo de onde o repositório Git do cliente estiver hospedado, uma ação do GitHub ou uma solução de integração contínua como Jenkins podem ser usadas para configurar a automação. Com uma automação em vigor, cada push para um repositório Git de propriedade do cliente pode ser encaminhado automaticamente para o repositório Git do Cloud Manager.

Embora essa automação para um único repositório Git de propriedade do cliente seja direta, a configuração desse repositório para vários repositórios requer uma configuração inicial. O conteúdo de vários repositórios Git precisa ser mapeado para diretórios diferentes no único repositório Git do Cloud Manager. O repositório Git do Cloud Manager precisa ser provisionado com um Maven raiz pom.xml, listando os diferentes subprojetos na seção de módulos.

Veja a seguir uma amostra pom.xml para dois repositórios git de propriedade do cliente.

  • O primeiro projeto será colocado no diretório chamado project-a.
  • O segundo projeto é colocado no diretório chamado 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>

Tal raiz pom.xml é enviado para uma ramificação no repositório Git do Cloud Manager. Em seguida, os dois projetos precisam ser configurados para encaminhar automaticamente as alterações para o repositório Git do Cloud Manager.

Uma solução possível seria a seguinte.

  1. Uma ação do GitHub pode ser acionada por um push para uma ramificação no projeto A.
  2. A ação verificará o projeto A e o repositório Git do Cloud Manager e copiará todo o conteúdo do projeto A para o diretório project-a no repositório Git do Cloud Manager.
  3. Em seguida, a ação enviará a alteração para commit.

Por exemplo, uma alteração na ramificação principal do projeto A é automaticamente enviada para a ramificação principal no repositório Git do Cloud Manager. É claro que pode haver um mapeamento entre ramificações como um push para uma ramificação chamada dev no projeto A é enviado para uma ramificação chamada development no repositório Git do Cloud Manager. São necessárias etapas semelhantes para o projeto B.

Dependendo da estratégia de ramificação e dos fluxos de trabalho, a sincronização pode ser configurada para ramificações diferentes. Se o repositório Git usado não fornecer um conceito semelhante às ações do GitHub, uma integração por meio de Jenkins (ou semelhante) também será possível. Nesse caso, um webhook aciona um emprego em Jenkins que faz o trabalho.

Siga estas etapas para adicionar uma nova, terceira fonte ou repositório.

  1. Adicione uma nova ação do GitHub ao novo repositório, que envia as alterações desse repositório para o repositório Git do Cloud Manager.
  2. Execute essa ação pelo menos uma vez para garantir que o código do projeto esteja no repositório Git do Cloud Manager.
  3. Adicione uma referência ao novo diretório no Maven raiz pom.xml no repositório git do Cloud Manager.

Exemplo de ação do GitHub

Esta é uma amostra da ação do GitHub acionada por um push para a ramificação principal e, em seguida, por push em um subdiretório do repositório Git do Cloud Manager. As ações do GitHub precisam ser fornecidas com dois segredos, MAIN_USER e MAIN_PASSWORD, para poder se conectar e enviar para o repositório Git do 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} 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

O uso de uma ação do GitHub é muito flexível. Qualquer mapeamento entre ramificações dos repositórios git pode ser executado, bem como qualquer mapeamento dos projetos git separados no layout de diretório do projeto principal.

OBSERVAÇÃO

O script de amostra usa git add para atualizar o repositório. Isso pressupõe que as remoções sejam incluídas. Dependendo da configuração padrão do git, talvez seja necessário substituí-la por git add --all.

Exemplo de trabalho do Jenkins

Este é um exemplo de script que pode ser usado em um trabalho do Jenkins ou similar e tem o seguinte fluxo:

  1. Ele é acionado por uma alteração em um repositório Git.
  2. O trabalho do Jenkins verifica o estado mais recente desse projeto ou ramificação.
  3. A tarefa então aciona esse script.
  4. Esse script, por sua vez, verifica o repositório Git do Cloud Manager e confirma o código do projeto em um subdiretório.

O trabalho do Jenkins precisa de dois segredos. MAIN_USER e MAIN_PASSWORD, para poder se conectar e enviar para o repositório Git do 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

Usar um emprego de Jenkins é muito flexível. Qualquer mapeamento entre ramificações dos repositórios git pode ser executado, bem como qualquer mapeamento dos projetos git separados no layout de diretório do projeto principal.

OBSERVAÇÃO

O script de amostra usa git add para atualizar o repositório. Isso pressupõe que as remoções sejam incluídas. Dependendo da configuração padrão do git, talvez seja necessário substituí-la por git add --all.

Nesta página