O Code Stream fornece uma maneira de disparar um pipeline se uma alteração de código ocorrer no repositório GitHub, GitLab ou Bitbucket. O gatilho Git usa um endpoint do Git na ramificação do repositório que você deseja monitorar. O Code Stream conecta-se ao endpoint do Git por meio de um webhook.

Para definir um endpoint do Git no Code Stream, selecione um projeto e insira a ramificação do repositório Git em que o endpoint está localizado. O projeto agrupa o pipeline com o endpoint e outros objetos relacionados. Ao escolher o projeto na definição de webhook, selecione o endpoint e o pipeline para disparar.
Observação: Se você definir um webhook com seu endpoint e, em seguida, editar o endpoint, não poderá alterar os detalhes do endpoint no webhook. Para alterar os detalhes do endpoint, você deve excluir e redefinir o webhook com o endpoint. Consulte Como usar o gatilho Git no Code Stream para executar um pipeline.

Você pode criar vários webhooks para ramificações diferentes usando o mesmo endpoint Git e fornecendo diferentes valores para o nome da ramificação na página de configuração do webhook. Para criar outro webhook para outra ramificação no mesmo repositório Git, não é necessário clonar o endpoint Git várias vezes para várias ramificações. Em vez disso, forneça o nome da ramificação no webhook, o que permite reutilizar o endpoint Git. Se a ramificação no webhook Git for a mesma que a ramificação no endpoint, você não precisará fornecer o nome da ramificação na página do webhook Git.

Pré-requisitos

  • Verifique se é possível acessar o repositório GitHub, GitLab ou Bitbucket ao qual pretende se conectar.
  • Verifique se você é membro de um projeto no Code Stream. Se não for, peça a um administrador do Code Stream para adicioná-lo como membro de um projeto. Consulte Como adicionar um projeto no Code Stream.

Procedimento

  1. Defina um endpoint do Git.
    1. Clique em Endpoints > Novo Endpoint.
    2. Selecione um projeto e para o tipo de endpoint e selecione Git. Em seguida, digite um nome e uma descrição.
    3. Se esse endpoint for um componente crítico para os negócios em sua infraestrutura, ative Marcar como restrito.
      Quando você usa um endpoint restrito em um pipeline, um administrador pode executar o pipeline e deve aprovar a execução desse pipeline. Se um endpoint ou uma variável estiver marcado como restrito, e um usuário não administrativo disparar o pipeline, este fará uma pausa nessa tarefa e esperará que um administrador a retome.
      Um administrador de projeto poderá iniciar um pipeline que inclua endpoints ou variáveis restritos se esses recursos estiverem no projeto em que o usuário é um Administrador de projeto.
      Quando um usuário que não é administrador tenta executar um pipeline que inclui um recurso restrito, o pipeline é interrompido na tarefa que usa esse recurso restrito. Em seguida, um administrador deve retomar o pipeline.
      Para obter mais informações sobre recursos restritos e funções personalizadas que incluem a permissão chamada Gerenciar Pipelines Restritos, consulte:
    4. Selecione um dos tipos de servidor Git compatíveis.
    5. Insira a URL do repositório com o gateway de API para o servidor no caminho. Por exemplo:
      Para o GitHub, insira: https://api.github.com/vmware-example/repo-example
      Para o BitBucket, insira: https://api.bitbucket.org/{user}/{repo name} ou http(s)://{bitbucket-enterprise-server}/rest/api/1.0/users/{username}/repos/{repo name}
    6. Insira a ramificação no repositório no qual o endpoint está localizado.
    7. Selecione o tipo de autenticação e digite o nome de usuário para GitHub, GitLab ou BitBucket. Em seguida, insira o token privado que acompanha o nome do usuário.
      • Senha. Para criar um webhook mais tarde, você deverá inserir o token privado para a senha. Webhooks para Git não oferecem suporte a endpoints criados usando autenticação básica.

        Use variáveis secretas para ocultar e criptografar informações confidenciais. Use a variável restrita para strings, senhas e URLs que devem ser ocultas e criptografadas e para restringir o uso em execuções. Por exemplo, use uma variável secreta para uma senha ou URL. Você pode usar variáveis secretas e restritas em qualquer tipo de tarefa no seu pipeline.

      • Token privado. Esse token é específico para o Git e fornece acesso a uma ação específica. Consulte https://docs.gitlab.com/ee/user/profile/personal_access_tokens.html. Você também pode criar uma variável para o token privado.
  2. Clique em Validar e verifique se o endpoint se conecta ao Code Stream.
    Se ele não se conectar, corrija os erros e clique em Criar.
    Quando você adiciona um endpoint Git, a definição do endpoint é concluída depois que você insere as informações, valida o endpoint e clica em Criar.

O que Fazer Depois

Para saber mais, leia as outras seções. Consulte Como usar o gatilho Git no Code Stream para executar um pipeline.