Integrar GitHub. Velocidade de mudança para DevOps. Espaço

  • Versão de lançamento: Zurich
  • Atualizado 31 de jul. de 2025
  • 10 min. de leitura

    • Conecte-se ao seu GitHub Instância que usa o playbook do Espaço de mudanças do DevOps para descobrir, configurar e importar repositórios, planos e pipelines.

    Antes de Iniciar

    Conclua as tarefas especificadas em Comece com Velocidade de mudança para DevOps tópico.

    Função necessária: sn_devops.admin ou sn_devops.tool_owner

    Procedimento

    1. Navegar até Espaços > Espaço de mudança de DevOps E use uma das seguintes opções para abrir o Playbook para integrar GitHub.
      OpçãoEtapas
      Página inicial
      1. Selecione Conecte uma ferramenta .
      2. No modal Conectar a uma ferramenta, selecione a ferramenta na categoria apropriada (Orquestração, Código, Plano ou Qualidade do software). Por exemplo, se você quiser se conectar a. GitHub como ferramenta de codificação, você selecionaria Ferramentas de codificação categoria.
      Módulo de aplicações
      1. Selecione Aplicações ( Ícone de aplicações.na navegação primária.
      2. Selecione uma aplicação existente ou crie uma. Para criar uma aplicação, consulte Criar uma aplicação - Espaço.
      3. No  painel Ações recomendadas, selecione  Conecte uma ferramenta  cartão.
      4. No modal Conectar a uma ferramenta, selecione a ferramenta na categoria apropriada. Por exemplo, se você quiser se conectar a. GitHub como ferramenta de codificação, selecione GitHub em Código categoria.
      Módulo de ferramentas
      1. Selecione Ferramentas ( Ícone Ferramentas.na navegação primária.
      2. Na lista Capacidade, selecione a categoria apropriada. Por exemplo, se você quiser se conectar a. GitHub como ferramenta de codificação, você selecionaria Codificação categoria.
      3. Selecione Conecte uma ferramenta .
      4. No  modal Conectar a uma ferramenta, selecione GitHub.
      Importante:
      Se você quiser descobrir e rastrear objetos de ferramenta, como pipelines, planos ou repositórios, ao se conectar à ferramenta, conecte sua ferramenta do módulo de aplicação.
    2. Em Nome da ferramenta , insira um nome para a ferramenta.

      Conete-se ao GitHub

    3. Selecione Avançar.

      . DevOps o playbook é aberto para ajudar você a concluir as tarefas de integração.

    4. Conclua a conexão e a configuração usando o playbook.
      1. Em Tipo de credencial , selecione um dos seguintes tipos de credencial.
        • Autoriz. básica
        • OAuth 2.0 com Código de autorização
        • OAuth 2.0 com token Web JSON (JWT)
      2. Insira as credenciais.
        Autoriz. básica

        Insira o nome de usuário e a senha/token de acesso do seu GitHub instância.

        Tipo de credencial de autenticação básica do GitHub.
        OAuth 2.0 com Código de autorização

        Selecione um registro de credencial OAuth 2,0 com código de autorização existente ou crie um registro de credencial OAuth 2,0 com código de autorização. Para obter mais informações, consulte Crie um registro de credencial para GitHub Provedor de app (código de autorização).

        GitHub OAuth 2,0 com tipo de credencial Código de autorização

        Nota:
        Se você estiver se conectando usando um aplicativo GitHub e estiver enfrentando problemas com a verificação de permissões, certifique-se de que o prefixo do ID do cliente do aplicativo GitHub esteja disponível na propriedade DevOps: Especificador de ID do cliente para o aplicativo GitHub . Para obter mais informações, consulte Adicione o ID do cliente à propriedade DevOps.
        OAuth 2.0 com token Web JSON (JWT)
        Para se conectar usando o OAuth 2,0 com um JWT, você deve primeiro executar o seguinte:
        Depois de concluir os pré-requisitos, você pode continuar com Velocidade de mudança para DevOps Atividade Playbook do Connect:
        1. Selecione Use um registro de credencial JWT existente Se você quiser usar um registro de credencial JWT já existente. Se esta opção não estiver selecionada, os campos para criar um novo registro de credencial JWT serão exibidos. Prossiga para a próxima etapa.
        2. Em Certificado JKS Selecione um certificado JKS existente. Este é o nome que você inseriu para identificar exclusivamente o provedor JWT. Certificados JKS são criados usando comandos de shell para criar um registro sys_certificate.

          Para obter mais informações, consulte Crie uma chave de assinatura JWT para GitHub Certificado JKS.

        3. Em Chave de assinatura Insira a chave de assinatura a ser atribuída ao seu certificado JKS. Esta é a senha de exportação inserida durante Gerando o certificado JKS .
        4. Em ID do app GitHub , selecione o ID do app do seu aplicativo GitHub (disponível na seção Sobre da configuração do aplicativo GitHub no GitHub). A imagem a seguir exibe um exemplo da seção Sobre de uma configuração do aplicativo GitHub de onde você pode acessar o ID do aplicativo GitHub, o ID do cliente e o segredo do cliente.

          Página Sobre do aplicativo GitHub

        5. Em ID do cliente Selecione o ID do cliente do seu aplicativo GitHub (disponível na seção Sobre da configuração do aplicativo GitHub no GitHub).
        6. Em Segredo do cliente Selecione o segredo do cliente do seu aplicativo GitHub (disponível na seção Sobre da configuração do aplicativo GitHub no GitHub).
        7. Em URL do token selecione o local do endpoint de token que a instância usa para recuperar e atualizar tokens.

          Para a versão em nuvem, insira: https://api.github.com/app/installations/<installation_id>/access_tokens .

          Para a versão empresarial, insira: https://<HOST_URL>/api/v3/app/instalations/<installation_id>/access_tokens .

          Para obter o ID de instalação, acesse a seção Instalar app na configuração do aplicativo GitHub no GitHub e selecione o ícone de engrenagem para configurar seu app. O ID de instalação estará no URL da página da web. Por exemplo, https://github.com/settings/installations/<installation_id>.

          GitHub OAuth 2,0 com tipo de credencial JWT.

        . Se a credencial OAuth for criada usando GitHub Apps - JWT, o. Configure com o aplicativo GitHub a opção estará disponível na página de registro da ferramenta.

        Nota:
        Se você estiver se conectando usando um aplicativo GitHub e estiver enfrentando problemas com a verificação de permissões, certifique-se de que o prefixo do ID do cliente do aplicativo GitHub esteja disponível na propriedade DevOps: Especificador de ID do cliente para o aplicativo GitHub . Para obter mais informações, consulte Adicione o ID do cliente à propriedade DevOps.

        Para obter mais informações sobre credenciais OAuth2.0, consulte Configurando GitHub Credenciais do OAuth 2,0 para Velocidade de mudança para DevOps.

      3. Opcional: Insira um valor em Nome do slug do aplicativo GitHub Campo para verificar os requisitos de permissão da ferramenta antes de se conectar se você criou suas credenciais do OAuth 2,0 usando os aplicativos do GitHub.
        Você pode encontrar o nome do slug do app na página de configurações do app.
      4. Opcional: . GitHub a instância está anexada a um MID Server. selecione MID Server e insira seus detalhes.

        Para obter mais informações sobre o MID Server, consulte Seleção DO MID Server .

        Nota:
        Os tipos de concessão Código de autorização OAuth e JWT são compatíveis com GitHub e GitHub Enterprise com MID Server.
      5. Selecione Conecte .

        Conete o GitHub ao DevOps Change Velocity.

      6. As verificações de permissão são executadas nas credenciais inseridas.

        As permissões necessárias e as permissões disponíveis são exibidas. Se você quiser inserir credenciais com permissões melhores, selecione Insira as credenciais novamente . Para obter informações detalhadas sobre todas as permissões necessárias, consulte GitHub permissões em Permissões necessárias para DevOps ferramentas.

        Para OAuth 2,0, se você não inseriu GitHub nome do slug da aplicação, a ferramenta está conectada sem verificar os requisitos de permissão.

      7. Selecione Avançar.

        Verificações de permissão

    5. Especifique o acesso para a ferramenta.
      1. Se você quiser controlar o acesso à ferramenta, adicione os grupos que devem ter acesso à ferramenta no Mantido por campo.
        As tarefas que esses usuários nos grupos podem executar dependem da função atribuída a eles.
        • DevOps Função de proprietário da ferramenta: Pode exibir e editar a ferramenta.
        • DevOps Função de proprietário da aplicação: Pode exibir a ferramenta e associar, descobrir, importar dados históricos e modificar etapas de pipeline (se aplicável) dos objetos da ferramenta (como planos, repositórios e pipelines).
        • DevOps Função de administrador: Pode editar todas as ferramentas.
        • Outro DevOps Funções: Pode exibir a ferramenta.
        Nota:
        Se você não selecionar um grupo e ignorar esta etapa, todos os usuários com DevOps A função de proprietário da ferramenta poderá editar a ferramenta.
      2. Se você optar por controlar o acesso à ferramenta, o Todos os proprietários de aplicações podem exibir e associar objetos de ferramenta a aplicações a opção se torna disponível para seleção.

        Esta opção permite que todos os usuários tenham DevOps Função de proprietário da aplicação para acessar a ferramenta. Se selecionado, eles poderão exibir, associar, descobrir, importar dados históricos e modificar etapas de pipeline (se aplicável) dos objetos da ferramenta.

      3. Selecione Atribuir.

      Especifique o acesso à ferramenta

    6. Configure webhooks automaticamente em seu GitHub instância para enviar dados Velocidade de mudança para DevOps.
      Esta ação configura os seguintes webhooks:
      • push: Para coletar confirmações, ramificações e marcadores do repositório
      • workflow_job: Para coletar dados de pipeline
      • issues: Para coletar dados de problemas (item de trabalho)
      Nota:
      Concluir a configuração como parte desta tarefa é recomendado, pois as notificações em tempo real são ideais para manter as informações atuais, especialmente para automatizar solicitações de mudança. Caso contrário, você pode configurar o webhook configurando-o manualmente posteriormente, habilitando a pesquisa noturna para buscar o sistema de dados para quaisquer repositórios ou pipelines rastreados, definindo Enable Pollingpropriedade para Sim .

      Selecione os repositórios para os quais você deseja configurar webhooks e selecione Configurar .

      Selecione Repositórios a serem configurados no GitHub.

      Para configurar manualmente, selecione Configurar manualmente . Para obter mais informações, consulte Configure webhooks no GitHub manualmente.

      Importante:
      • Se você estiver se conectando a partir da página inicial ou do módulo Ferramentas, a conexão estará concluída e você será direcionado para a página Resumo.
      • Se você estiver se conectando a partir do módulo Aplicações, os repositórios e pipelines disponíveis serão descobertos. Você pode rastrear e importar dados históricos deles.
    7. Selecione os planos a serem rastreados.

      1. Selecione os planos para os quais você deseja rastrear atualizações e associar à aplicação.

        Após a conclusão da integração da ferramenta, os itens de trabalho somente para esses planos selecionados serão importados automaticamente.

      2. Selecione Avançar.

        Rastrear etapa do playbook de planos

    8. Selecione os repositórios a serem rastreados.
      1. Selecione os repositórios cujos atualizações você deseja rastrear e associar à aplicação.

      2. Selecione Avançar.

        Selecione Repositórios para acompanhamento.

      3. Se você quiser importar dados do repositório, selecione o intervalo de datas e selecione Enviar .

        Você pode importar até 90 dias de dados. Os fluxos de trabalho associados aos repositórios também serão importados.

    9. Selecione os pipelines a serem rastreados.

      1. Selecione os pipelines cujas atualizações você deseja rastrear e associar à aplicação.

      2. Selecione Avançar.

      3. Para cada pipeline selecionado, todas as etapas ou fases são importadas para a última execução bem-sucedida. Na atividade Atribuir serviços a etapas de pipeline, você pode selecionar o seguinte para cada etapa de pipeline:

        1. Tipo de etapa de pipeline : Selecione um tipo de etapa para o qual você deseja atribuir um serviço.

          Dica:
          Especifique pelo menos Prod deploytipo de etapa para etapas que representam a implantação de produção a ser habilitada DevOps identificar execuções de pipeline bem-sucedidas como implantações de produção.

        2. Serviço : Selecione CMDB serviço de aplicações para o qual a etapa de pipeline é mapeada.

          O serviço de aplicações mapeia aproximadamente para o ambiente. Se você usar a mesma etapa de pipeline para implantar em ambientes diferentes, deixe o campo em branco. As informações de serviço habilitam DevOps identificar e relatar métricas operacionais, como incidentes, indisponibilidades e assim por diante.

      4. Selecione Avançar.

        Atribua serviços a pipelines do GitHub.

    10. Em Resumo , selecione Exibir registro da ferramenta para revisar os detalhes do conectado GitHub ferramenta.

      Resumo da conexão

      Para GitHub Actions pipelines, você deve executar algumas etapas adicionais, como criar segredos, definir a configuração do fluxo de trabalho em GitHub e assim por diante. Para obter mais informações, consulte GitHub Actions configurações.

    Resultado

    Você integrou com sucesso seu GitHub ferramenta para Velocidade de mudança para DevOps.

    O que Fazer Depois

    Você também pode descobrir planos manualmente depois que sua ferramenta do GitHub for integrada. Como não há entidade de plano no GitHub, os repositórios serão considerados para descobrir registros de plano correspondentes na ServiceNow.

    1. Na página de registro da ferramenta, selecione Descobrir para descobrir planos.
    2. Selecione Configurar. Os planos são rastreados e um webhook é chamado issuesé criado para enviar notificações em tempo real para itens de trabalho.
    As informações a seguir são atualizadas para um item de trabalho na ServiceNow quando o problema correspondente é atualizado no GitHub.
    • Mudança no título do problema
    • Atualização dos designados
    • Problema de transferência
      Nota:
      Quando um problema é transferido, o mesmo será marcado como transferido no repositório do qual está sendo transferido e aberto no repositório para o qual está sendo transferido.
    • Excluir ocorrência
      Nota:
      Quando um problema é excluído no GitHub, o item de trabalho correspondente não é excluído na ServiceNow, mas o estado do item de trabalho será marcado como excluído.

    Se você for um cliente de upgrade, os planos serão descobertos para seus repositórios por meio do trabalho agendado para descobrir periodicamente ou por meio da descoberta manual. Depois que seus planos forem descobertos, você poderá habilitar sn_devops.track.github.issuespropriedade para reconfigurar todos os repositórios configurados anteriormente de uma só vez para que todos os planos sejam rastreados e o webhook de problemas seja criado para itens de trabalho.

    Nota:
    A importação histórica de planos não é compatível.