[Beta privado]{class="badge positive"}

Adicionar repositórios externos no Cloud Manager external-repositories

Saiba como adicionar um repositório externo no Cloud Manager. O Cloud Manager oferece suporte à integração com repositórios GitHub Enterprise, GitLab e Bitbucket.

NOTE
Os recursos descritos neste artigo só estão disponíveis por meio do programa beta privado. Para obter mais detalhes e para se inscrever no beta privado, consulte Traga seu próprio Git.

Configurar um repositório externo

A configuração de um repositório externo no Cloud Manager consiste em três etapas:

Adicione um repositório externo add-ext-repo

NOTE
Repositórios externos não podem ser vinculados aos Pipelines de configuração.
  1. Faça logon no Cloud Manager, em my.cloudmanager.adobe.com, e selecione a organização apropriada.

  2. No console Meus Programas, selecione o programa ao qual deseja vincular um repositório externo.

  3. No menu lateral, em Programa, clique em Ícone de estrutura de tópicos de pastas Repositórios.

    A página Repositórios

  4. Próximo ao canto superior direito da página Repositórios, clique em Adicionar Repositório.

  5. Na caixa de diálogo Adicionar repositório, selecione Repositório privado para vincular um repositório Git externo ao seu programa.

    Adicionar repositório próprio

  6. Em cada campo respectivo, forneça os seguintes detalhes sobre o repositório:

    table 0-row-2 1-row-2 2-row-2 3-row-2 4-row-2
    Texto Descrição
    Nome do repositório Obrigatório. Um nome expressivo para o novo repositório.
    URL do repositório Obrigatório. O URL do repositório.

    Se você estiver usando um repositório hospedado pelo GitHub, o caminho deverá terminar em .git.
    Por exemplo, https://github.com/org-name/repo-name.git (o caminho da URL é apenas ilustrativo).

    Se você estiver usando um repositório externo, ele deverá usar o seguinte formato de caminho de URL:
    https://git-vendor-name.com/org-name/repo-name.git
    ou
    https://self-hosted-domain/org-name/repo-name.git
    e corresponder ao seu fornecedor de Git.
    Selecionar tipo de repositório

    Obrigatório. Selecione o tipo de repositório que você está usando:

    • GitHub (GitHub Enterprise e a versão auto-hospedada do GitHub)
    • GitLab (o gitlab.com e a versão auto-hospedada do GitLab)
    • Bitbucket (somente bitbucket.org (versão em nuvem) tem suporte. A versão auto-hospedada do Bitbucket foi descontinuada a partir de 15 de fevereiro de 2024.)

    Se o caminho do URL do repositório acima incluir o nome do fornecedor do Git, como GitLab ou Bitbucket, o tipo de repositório já estará pré-selecionado.

    Descrição Opcional. Uma descrição detalhada do repositório.
  7. Clique em Salvar para adicionar o repositório.

    Agora, forneça um token de acesso para validar a propriedade do repositório externo.

  8. Na caixa de diálogo Validação de Propriedade de Repositório Privado, forneça um token de acesso para validar a propriedade do repositório externo para que você possa acessá-lo e clique em Validar.

    Seleção de um token de acesso para um repositório
    Selecionando um token de acesso existente para um repositório Bitbucket (somente para ilustração).

GitHub Enterprise
table 0-row-2 1-row-2 2-row-2
Opção de token de acesso Descrição
Usar token de acesso já existente Se você já forneceu um token de acesso ao repositório para sua organização e tem acesso a vários repositórios, você pode selecionar um token. Use a lista suspensa Nome do token para escolher o token que deseja aplicar ao repositório. Caso contrário, adicione um novo token de acesso.
Adicionar novo token de acesso
  • No campo de texto Nome do token, digite um nome para o token de acesso que você está criando.

  • Crie um token de acesso pessoal seguindo as instruções na documentação do GitHub.

  • Permissões necessárias para o GitHub Enterprise Personal Access Token (PAT)
    Essas permissões garantem que o Cloud Manager possa validar solicitações de pull, gerenciar verificações de status de confirmação e acessar detalhes do repositório necessários.
    Ao gerar o PAT no GitHub Enterprise, verifique se ele inclui as seguintes permissões de repositório:

    • Solicitação de pull (leitura e gravação)
    • Status de confirmação (leitura e gravação)
    • Metadados do repositório (somente leitura)
  • No campo Token de acesso, cole o token que acabou de criar.

Após a validação, o repositório externo estará pronto para ser usado e vinculado a um pipeline.

Consulte também Gerenciar tokens de acesso.

GitLab
table 0-row-2 1-row-2 2-row-2
Opção de token de acesso Descrição
Usar token de acesso já existente Se você já forneceu um token de acesso ao repositório para sua organização e tem acesso a vários repositórios, você pode selecionar um token. Use a lista suspensa Nome do token para escolher o token que deseja aplicar ao repositório. Caso contrário, adicione um novo token de acesso.
Adicionar novo token de acesso
  • No campo de texto Nome do token, digite um nome para o token de acesso que você está criando.

  • Crie um token de acesso pessoal seguindo a instrução na documentação do GitLab.

  • Permissões necessárias para o GitLab Personal Access Token (PAT)
    Esses escopos permitem que o Cloud Manager acesse dados do repositório e informações do usuário, conforme necessário, para validação e integração com webhook.
    Ao gerar o PAT no GitLab, certifique-se de que ele inclua os seguintes escopos de token:

    • api
    • read_user
  • No campo Token de acesso, cole o token que acabou de criar.

Após a validação, o repositório externo estará pronto para ser usado e vinculado a um pipeline.

Consulte também Gerenciar tokens de acesso.

Bitbucket
table 0-row-2 1-row-2 2-row-2
Opção de token de acesso Descrição
Usar token de acesso já existente Se você já forneceu um token de acesso ao repositório para sua organização e tem acesso a vários repositórios, você pode selecionar um token. Use a lista suspensa Nome do token para escolher o token que deseja aplicar ao repositório. Caso contrário, adicione um novo token de acesso.
Adicionar novo token de acesso
  • No campo de texto Nome do token, digite um nome para o token de acesso que você está criando.

  • Crie um token de acesso do repositório usando a documentação do Bitbucket.

  • Permissões necessárias para o PAT (token de acesso pessoal) do Bitbucket
    Essas permissões permitem que o Cloud Manager acesse o conteúdo do repositório, gerencie solicitações de pull e configure ou reaja a eventos de webhook.
    Ao criar a senha de aplicativo no Bitbucket, verifique se ela inclui as seguintes permissões de senha de aplicativo necessárias:

    • Repositório (somente leitura)
    • Solicitações de pull (leitura e gravação)
    • Webhooks (leitura e gravação)
  • No campo Token de acesso, cole o token que acabou de criar.

Após a validação, o repositório externo estará pronto para ser usado e vinculado a um pipeline.

Consulte também Gerenciar tokens de acesso.

Vincular um repositório externo validado a um pipeline validate-ext-repo

  1. Adicionar ou editar um pipeline:

    Repositório de código-fonte do pipeline e ramificação Git
    Caixa de diálogo Adicionar pipeline de não produção com o repositório selecionado e a ramificação Git,

  2. Ao adicionar ou editar um pipeline, para especificar o local do Código-fonte para seu pipeline novo ou já existente, escolha o repositório externo que deseja usar na lista suspensa Repositório.

  3. Na lista suspensa Ramificação Git, selecione a ramificação como a origem do pipeline.

  4. Clique em Salvar.

TIP
Para obter detalhes sobre como gerenciar repositórios no Cloud Manager, consulte Repositórios do Cloud Manager.

Configurar um webhook para um repositório externo configure-webhook

O Cloud Manager permite configurar webhooks para repositórios Git externos adicionados. Consulte Adicionar um repositório externo. Esses webhooks permitem que o Cloud Manager receba eventos relacionados a diferentes ações na solução do fornecedor Git.

Por exemplo, webhooks permitem que o Cloud Manager acione ações com base em eventos como os seguintes:

  • Criação de solicitação de pull (PR) - Inicia a funcionalidade de validação de PR.
  • Eventos de push - Inicia pipelines quando o acionador "Na confirmação do Git" está ativado (ativado).
  • Ações futuras baseadas em comentários - Permite fluxos de trabalho, como implantação direta de uma PR, em um RDE (Rapid Development Environment, ambiente de desenvolvimento rápido).

A configuração do Webhook não é necessária para repositórios hospedados em GitHub.com porque o Cloud Manager se integra diretamente por meio do aplicativo GitHub.

Para todos os outros repositórios externos integrados com um token de acesso, como GitHub Enterprise, GitLab e Bitbucket, a configuração de webhook está disponível e deve ser definida manualmente.

Para configurar um webhook para um repositório externo:

  1. Faça logon no Cloud Manager, em my.cloudmanager.adobe.com, e selecione a organização apropriada.

  2. No console Meus programas, selecione o programa para o qual deseja configurar um webhook para um repositório Git externo.

  3. No canto superior esquerdo da página, clique em Mostrar ícone de menu para exibir o menu do lado esquerdo.

  4. No menu à esquerda, no cabeçalho Programa, clique em Ícone de estrutura de tópicos de pastas Repositórios.

  5. Na página Repositórios, usando a coluna Tipo para orientá-lo na sua seleção, localize o repositório desejado e clique em Reticências - Ícone Mais ao lado dele.

    Opção de Webhook de configuração no menu suspenso para um repositório selecionado

  6. No menu suspenso, clique em Configurar Webhook.

    Caixa de diálogo Configurar Webhook

  7. Na caixa de diálogo Webhook de configuração, faça o seguinte:

    1. Ao lado do campo URL do Webhook, clique em Ícone de cópia .
      Cole o URL em um arquivo de texto sem formatação. A URL copiada é necessária para as configurações do Webhook do fornecedor do Git.
    2. Ao lado do campo de token/chave Segredo do Webhook, clique em Gerar e em Ícone Copiar .
      Cole o segredo em um arquivo de texto simples. O segredo copiado é necessário para as configurações de Webhook do fornecedor de Git.
  8. Clique em Fechar.

  9. Navegue até a solução do fornecedor de Git (GitHub Enterprise, GitLab ou Bitbucket).

    Todos os detalhes sobre a configuração do webhook e os eventos necessários para cada fornecedor estão disponíveis em Adicionar um repositório externo. Na etapa 8, consulte a tabela com guias.

  10. Localize a seção Configurações do Webhook da solução.

  11. Cole o URL do Webhook copiado anteriormente no campo de texto do URL.

    1. Substitua o parâmetro de consulta api_key na URL do Webhook pela sua própria chave de API real.

      Para gerar uma chave de API, você deve criar um projeto de integração no Adobe Developer Console. Consulte Criando um Projeto de Integração de API para obter detalhes completos.

  12. Cole o Segredo do Webhook copiado anteriormente no campo de texto Segredo (ou Chave secreta ou Token secreto).

  13. Configure o webhook para enviar os eventos exigidos pelo Cloud Manager. Use a tabela a seguir para determinar os eventos corretos para seu provedor Git.

GitHub Enterprise
table 0-row-1 1-row-1
Eventos de webhook necessários

Esses eventos permitem que o Cloud Manager responda à atividade do GitHub, como validação de solicitação de pull, acionadores baseados em push para pipelines ou sincronização de código do Edge Delivery Services.
Verifique se o webhook está configurado para disparar os seguintes eventos do webhook necessários:

  • Solicitações de pull
  • Envios por push
  • Comentários do problema
GitLab
table 0-row-1 1-row-1
Eventos de webhook necessários

Esses eventos de webhook permitem que o Cloud Manager acione pipelines quando o código é enviado por push ou uma solicitação de mesclagem é enviada. Eles também rastreiam comentários relacionados à validação da solicitação de pull (por meio de eventos de observação).
Verifique se o webhook está configurado para ser acionado nos seguintes eventos necessários do webhook

  • Eventos de push
  • Mesclar eventos de solicitação
  • Anotar eventos
Bitbucket
table 0-row-1 1-row-1
Eventos de webhook necessários

Esses eventos garantem que o Cloud Manager possa validar solicitações de pull, responder a envios por código e interagir com comentários para coordenação de pipeline.
Verifique se o webhook está configurado para ser acionado nos seguintes eventos necessários do webhook

  • Solicitação de pull: criada
  • Solicitação de pull: atualizada
  • Solicitações de pull: mescladas
  • Solicitação de pull: comentário
  • Repositório: push

Validação de pull requests com webhooks

Depois que os webhooks são configurados corretamente, o Cloud Manager aciona automaticamente execuções de pipeline ou verificações de validação de solicitação de pull (PR) para seu repositório.

O comportamento varia dependendo do provedor Git que você usa, conforme descrito abaixo.

GitHub Enterprise

Quando a verificação é criada, ela é exibida como a seguinte captura de tela abaixo. A principal diferença em relação a GitHub.com é que GitHub.com usa uma execução de verificação, enquanto o GitHub Enterprise (usando tokens de acesso pessoal) gera um status de confirmação:

Confirmar status para indicar o processo de validação de PR no GitHub Enterprise

GitLab

As interações do GitLab dependem apenas de comentários. Quando a validação começar, um comentário será adicionado. Quando a validação for concluída (com êxito ou com falha), o comentário inicial será removido e substituído por um novo comentário que conterá os resultados da validação ou os detalhes do erro.

Quando a validação de qualidade do código estiver em execução:

Quando a validação de qualidade do código estiver em execução

Quando a validação da qualidade a frio for concluída:

Quando a validação da qualidade a frio for concluída

Quando a validação da qualidade do código falha com um erro:

Quando a validação de qualidade do código falha com um erro

Quando a validação da qualidade do código falhar devido a problemas do cliente:

Quando a validação da qualidade do código falhar devido a problemas do cliente

Bitbucket

Quando a validação de qualidade do código estiver em execução:

Status enquanto a validação de qualidade do código está em execução

Usa o status de confirmação para rastrear o progresso da validação da PR. No caso a seguir, a captura de tela mostra o que acontece quando uma validação de qualidade de código falha devido a um problema do cliente. Um comentário é adicionado com informações detalhadas sobre o erro e uma verificação de confirmação é criada, mostrando a falha (visível à direita):

Status de validação da solicitação de pull para Bitbucket

Solução de problemas de webhook

  • Verifique se o URL do Webhook inclui uma chave de API válida.
  • Verifique se os eventos do webhook estão configurados corretamente nas configurações do fornecedor do Git.
  • Se a validação de PR ou os acionadores de pipeline não estiverem funcionando, verifique se o Segredo do Webhook está atualizado no Cloud Manager e no fornecedor do Git.
recommendation-more-help
c6cdc82b-cee9-48e0-a6ee-48149d5e72c3