GitHub

Com o conector do GitHub, é possível executar operações de inserção, exclusão, atualização e leitura nos dados do GitHub.

Antes de começar

Antes de usar o conector do GitHub, execute as seguintes tarefas:

• No seu projeto do Google Cloud, faça o seguinte:
  • Conceda a função IAM roles/connectors.admin ao usuário que está configurando o conector.
  • Conceda os seguintes papéis de IAM à conta de serviço que você quer usar para o conector:
    • roles/secretmanager.viewer
    • roles/secretmanager.secretAccessor

    Uma conta de serviço é um tipo especial de Conta do Google destinada a representar um usuário não humano que precisa ser autenticado e autorizado a acessar dados nas APIs do Google. Se você não tiver uma conta de serviço, será necessário criar uma. Para mais informações, consulte Como criar uma conta de serviço.

  • Ativar os seguintes serviços
    • secretmanager.googleapis.com (API Secret Manager)
    • connectors.googleapis.com (API Connectors)

    Para entender como ativar os serviços, consulte Como ativar serviços.

  Se esses serviços ou permissões não tiverem sido ativados no seu projeto, você precisará ativá-los ao configurar o conector.

• No GitHub, com base nos seus requisitos, conclua as seguintes tarefas:
  • Crie uma conta do GitHub.
  • Crie novos repositórios.
  • Criar novas organizações.
  • Criar projetos.
  • Crie um app OAuth.
  • Crie um app do GitHub.

  Configurar o conector

  Para configurar o conector, crie uma conexão com a fonte de dados (sistema de back-end). Uma conexão é específica a uma fonte de dados. Isso significa que, se você tiver muitas fontes de dados, precisará criar uma conexão separada para cada uma. Para criar uma conexão, siga estas etapas:

  1. No console do Cloud, acesse a página Integration Connectors > Conexões e selecione ou crie um projeto do Google Cloud.

     Acessar a página "Conexões"

  2. Clique em + CRIAR NOVO para abrir a página Criar conexão.
  3. Na seção Local, escolha o local da conexão.
     1. Região: selecione um local na lista suspensa.

        Para conferir a lista de todas as regiões com suporte, consulte Locais.

     2. Clique em PRÓXIMA.
  4. Na seção Detalhes da conexão, faça o seguinte:
     1. Conector: selecione GitHub na lista suspensa de conectores disponíveis.
     2. Versão do conector: selecione a versão do conector na lista suspensa de versões disponíveis.
     3. No campo Nome da conexão, insira um nome para a instância de conexão

        Os nomes de conexão precisam atender aos seguintes critérios:

        • Os nomes de conexões podem usar letras, números ou hifens.
        • As letras precisam ser minúsculas.
        • Os nomes das conexões precisam começar com uma letra e terminar com uma letra ou um número.
        • Os nomes das conexões não podem ter mais de 49 caracteres.
     4. Como opção, insira uma Descrição para a instância de conexão.
     5. Como opção, ative o Cloud Logging e selecione um nível de registro. Por padrão, o nível de registro é definido como Error.
     6. Conta de serviço: selecione uma conta de serviço que tenha os papéis necessários.
     7. Opcionalmente, especifique OwnerLogin: um nome de login exclusivo que pertence a um usuário ou a uma organização.
     8. Se quiser, especifique Esquema: use o esquema para restringir os esquemas recuperados dinamicamente a um esquema específico de projeto ou repositório. Para recuperar todos os esquemas, não especifique nenhum valor neste campo. Para informações sobre os esquemas compatíveis, consulte Esquemas e escopos.
     9. Opcionalmente, defina as Configurações do nó de conexão:
        • Número mínimo de nós: digite o número mínimo de nós de conexão.
        • Número máximo de nós: digite o número máximo de nós de conexão.

        Um nó é uma unidade (ou réplica) de uma conexão que processa transações. Mais nós são necessários para processar mais transações para uma conexão e, por outro lado, menos nós são necessários para processar menos transações. Para entender como os nós afetam os preços do conector, consulte Preços dos nós de conexão. Se você não inserir qualquer valor, por padrão, os nós mínimos serão definidos como 2 (para melhor disponibilidade) e os nós máximos serão definidos como 50.

     Observação: você só poderá personalizar os valores do nó de conexão se for um cliente de pagamento por utilização.
     10. Outra opção é clicar em + ADICIONAR MARCADOR para adicionar um rótulo à conexão na forma de um par de chave-valor.
     11. Clique em PRÓXIMA.
  5. Na seção Destinos, insira os detalhes do host remoto (sistema de back-end) ao qual você quer se conectar.
     1. Tipo de destino: selecione um Tipo de destino.
        • Selecione Endereço do host na lista para especificar o nome do host ou o endereço IP do destino.
        • Para estabelecer uma conexão particular com seus sistemas de back-end, Selecione Anexo de endpoint na lista e depois selecione o anexo de endpoint necessário. na lista Endpoint Attachment.
          Observação : para entender como criar um anexo de endpoint, consulte Anexo de serviço PSC e anexo de endpoint. Depois de ter criado o anexo de endpoint, ele vai aparecer na lista Anexo do endpoint.

        Para estabelecer uma conexão pública com os sistemas de back-end com mais segurança, considere configurar endereços IP de saída estáticos para suas conexões e configure as regras de firewall para autorizar apenas os endereços IP estáticos específicos.

        Para inserir outros destinos, clique em +ADICIONAR DESTINO.

     2. Clique em PRÓXIMA.
  6. Na seção Autenticação, insira os detalhes da autenticação.

     Para entender como configurar esses tipos de autenticação, consulte Configurar autenticação.

  7. Clique em PRÓXIMA.
  8. Revisão: revise os detalhes de conexão e autenticação.
  9. Clique em Criar.

  Configurar a autenticação

  Digite os detalhes com base na autenticação que você quer usar.

  • ID do cliente: o ID usado para solicitar tokens de acesso.
  • Escopos: uma lista separada por vírgulas dos escopos desejados.
  • Chave secreta do cliente: o secret do Secret Manager que contém a chave secreta do cliente para o app conectado que você criou.

  Exemplos de configuração de conexão

  Esta seção lista os exemplos de valores para as diversas campos que você configura ao criar a conexão.

  OAuth 2.0: tipo de conexão de código de autorização

  Nome do campo	Detalhes
  Local	europe-west1
  Conector	GitHub
  Versão do conector	1
  Nome da conexão	Conector do GitHub
  Ativar Cloud Logging	Não
  Conta de serviço	Your_Project_Number@serviceaccount
  OwnerLogin	souvikg-Your_Owner_Login
  Esquema
  Número mínimo de nós	2
  Número máximo de nós	50
  ID do cliente	ClientID
  Escopos	repo:status repo_deployment
  Chave secreta do cliente	Chave secreta do cliente
  Versão do secret	1

  Esquemas e escopos do GitHub

  O conector do GitHub é compatível com os seguintes esquemas:
  • Esquema de informações: esse esquema contém tabelas com informações de licenciamento e visões gerais de alto nível dos projetos e repositórios associados à conta autenticada. Existe apenas um esquema de informações. Para recuperar o esquema de informações, especifique o seguinte no campo do esquema: Informações
  • Esquema do repositório: o conector oferece suporte ao esquema de cada repositório na conta do usuário ou da organização autenticada. Use o seguinte formato para especificar um esquema de repositório: Repository_.
  • Esquema do projeto: o conector oferece suporte ao esquema de cada projeto na conta do usuário ou da organização autenticada. Use o seguinte formato para especificar um esquema de projeto: Project_

  Para saber mais sobre escopos, consulte Escopos do GitHub (link em inglês).

  Entidades, operações e ações

  Todos os Integration Connectors fornecem uma camada de abstração para os objetos do aplicativo conectado. Só é possível acessar os objetos de um aplicativo por esta abstração. A abstração é exposta a você como entidades, operações e ações.

  Observação:você pode ver as entidades, as operações e as ações de um conector na tarefa de conectores.
  • Entidade: uma entidade pode ser considerada um objeto ou um conjunto de propriedades no aplicativo ou serviço conectado. A definição de uma entidade difere de um conector para outro. Por exemplo, em um conector de banco de dados, as tabelas são as entidades, em um conector de servidor de arquivos, as pastas são as entidades e, em um conector de sistema de mensagens, as filas são as entidades.

    No entanto, é possível que um conector não aceite ou não tenha entidades. Nesse caso, a lista Entities estará vazia.

  • Operação: uma operação é a atividade que pode ser realizada em uma entidade. É possível executar qualquer uma das seguintes operações em uma entidade:
    • Lista
    • Receber
    • Criar
    • Atualizar
    • Excluir

    Selecionar uma entidade na lista disponível gera uma lista de operações disponíveis para ela. Para uma descrição detalhada das operações, consulte as operações de entidades da tarefa "Conectores". No entanto, se um conector não oferecer suporte a nenhuma das operações da entidade, como as operações não estão listadas na lista Operations.

  • Ação: uma ação é uma função de primeira classe disponibilizada para a integração por meio da interface do conector. Uma ação permite fazer alterações em uma ou mais entidades e varia de um conector para outro. Normalmente, uma ação tem alguns parâmetros de entrada, . No entanto, é possível que o conector não ofereça suporte a nenhuma ação. Nesse caso, a lista Actions estará vazia.
  Observação: todas as entidades e ações terão um esquema associado a elas. Por exemplo, um esquema de ação terá os detalhes do parâmetro, como: os nomes do parâmetro e tipos de dados correspondentes. O esquema (metadados) de entidades e ações é buscado pela conexão em do seu back-end. Se houver atualizações no esquema, elas não serão refletidas automaticamente nas suas conexões. Faça isso manualmente. Para atualizar o esquema de uma conexão, abra a página Detalhes da conexão e clique em Atualizar esquema de conexão.

  Limitações do sistema

  O conector do GitHub pode processar duas transações por segundo, por nó, e limita qualquer transação além desse limite. Por padrão, os Integration Connectors alocam dois nós (para melhor disponibilidade) para uma conexão.

  Para informações sobre os limites aplicáveis aos Integration Connectors, consulte Limites.

  Observação: o número de nós de Integration Connectors vai ser escalonado automaticamente de forma dinâmica com base no seu uso. No entanto, se você quiser reservar capacidade para grandes volumes aguardando o escalonamento automático, ajuste o valor mínimo do nó para uma conexão. Mais nós são necessários para processar mais transações para uma conexão. Por outro lado, menos nós são necessários se uma conexão processa menos transações. Para configurar os valores do nó, faça o seguinte:

  • Se você é um cliente de pagamento por uso, configure os valores mínimo e máximo do nó na página "Editar conexão".
  • Se você for um cliente de assinatura, entre em contato com o suporte.

  O número máximo de transações que um nó pode processar depende de vários fatores. Portanto, antes de ajustar os nós mínimos para melhorar a capacidade de processamento, verifique se os sistemas de back-end estão configurados de maneira ideal para lidar com o tráfego necessário.

  Ação

  Esta seção lista a ação aceita pelo conector do GitHub. Para saber como configurar ação, consulte os Exemplos de ação.

  Ação UpdatePullRequestBranch

  Essa ação atualiza a ramificação da solicitação de envio.

  Parâmetros de entrada da ação UpdatePullRequestBranch

  Nome	Tipo	Descrição
  PullRequestId	string	O ID do nó da solicitação de envio.
  ExpectedHeadOid	string	O oid de referência da cabeça para a ramificação upstream.
  UpdateMethod	string	O método de atualização da ramificação a ser usado. O padrão é "MERGE". Os valores permitidos são MERGE e REBASE.

  Parâmetros de saída da ação AppsDeployStatus

  Essa ação retorna o status 200 (OK) e atualiza a ramificação da solicitação de envio.

  Por exemplo, sobre como configurar a ação UpdatePullRequestBranch, consulte Exemplos.

  Ação MergePullRequest

  Essa ação mescla a solicitação de envio.

  Parâmetros de entrada da ação MergePullRequest

  Nome	Tipo	Descrição
  PullRequestId	string	O ID do nó da solicitação de envio a ser mesclada.
  ExpectedHeadOid	string	OID que a referência do cabeçalho da solicitação de envio precisa corresponder para permitir a mesclagem. se omitido, nenhuma verificação é realizada.
  CommitHeadline	string	Título do commit que será usado na confirmação de mesclagem. se omitido, uma mensagem padrão será usada.
  CommitBody	string	Corpo da confirmação a ser usado para a confirmação de mesclagem. Se omitido, uma mensagem padrão será usada.
  MergeMethod	string	O método de mesclagem a ser usado. O padrão é "MERGE". Os valores permitidos são MERGE, SQUASH e REBASE.
  AuthorEmail	string	O endereço de e-mail a ser associado a esta mesclagem.

  Parâmetros de saída da ação MergePullRequest

  Essa ação retorna o status 200 (OK) e mescla a solicitação de pull.

  Para saber como configurar a ação MergePullRequest, consulte Exemplos.

  Exemplos de ação

  Esta seção descreve como realizar algumas das ações neste conector.

  Exemplo: UpdatePullRequestBranch

  Este exemplo recupera os status de implantação do aplicativo.

  1. Na caixa de diálogo Configure connector task, clique em Action.
  2. Selecione a ação UpdatePullRequestBranch e clique em Concluído.
  3. Na seção Entrada de tarefa da tarefa Conectores, clique em connectorInputPayload e insira um valor semelhante ao seguinte no campo Campo Default Value:

           {
         "PullRequestId": "PR_kwDOLywhW8537gcA"
           } 
       

  Se a ação for bem-sucedida, o UpdatePullRequestBranch resposta da tarefa connectorOutputPayload terá um valor semelhante ao seguinte:

         {
      "pullrequestid": "PR_kwDOLywhW8537gcA"
         } 
    

  Exemplo: MergePullRequest

  Este exemplo mescla uma solicitação de pull.

  1. Na caixa de diálogo Configure connector task, clique em Action.
  2. Selecione a ação MergePullRequest e clique em Concluído.
  3. Na seção Entrada de tarefa da tarefa Conectores, clique em connectorInputPayload e insira um valor semelhante ao seguinte no campo Campo Default Value:

           {
         "PullRequestId": "PR_kwDOLywhW8537gcA",
         "CommitHeadline": "Google MERGE",
         "CommitBody": "This is Google Merge"
           }
       

  Se a ação for bem-sucedida, o parâmetro de resposta connectorOutputPayload da tarefa MergePullRequest terá um valor semelhante a este:

          {
      "pullrequestid": "PR_kwDOLywhW8537gcA"
          } 
    

  Exemplos de operações de entidade

  Esta seção mostra como executar algumas das operações de entidade neste conector.

  Exemplo: operação LIST para a entidade "Branches"

  1. Na caixa de diálogo Configure connector task, clique em Entities.
  2. Selecione Branches na lista Entity.
  3. Selecione a operação LIST e clique em Concluído.
  4. Entrada de tarefa da tarefa Conectores, você pode definir o filterClause de acordo com o requisito do cliente. Confira a seção "Observação" abaixo.

  Neste exemplo, branches é o nome da entidade, e o valor da cláusula de filtro precisa ser sempre transmitido entre aspas simples ("), como City='Pune'. Cidade é o nome da coluna e Pune é o valor

  É possível usar a cláusula Filtro para filtrar um determinado conjunto de registros com base em colunas. Se houver 20 registros com name = demo16975280986860, você poderá filtrar os registros com a coluna Address='Miami' e region='us-east1'.

  Você pode executar operações LIST nas seguintes entidades:

  Commits, CommitComments, Forks, IssueComments, Issue, IssueAssignees, AssignableUser, Labels, Milestones, PullRequestReviews, PullRequests, PullRequestComments, ReleaseAssets, Releases, Watcher, Users, Repositories, Collaborators, OrganizationTeams, OrganizationsMannequins, OrganizationMember, Organization, Licenses, LicensePermission, LicenseLimitation, LicenseConditions, Projects e PullRequestReviewRequests.

  Exemplo: operação GET para a entidade "Branches"

  1. Na caixa de diálogo Configure connector task, clique em Entities.
  2. Selecione Branches na lista Entity.
  3. Selecione a operação GET e clique em Concluído.
  4. Defina o ID da entidade como 4, que é a chave a ser transmitida. Para definir o ID da entidade, em Na seção Task Input da tarefa Connectors, clique em EntityId e e insira 4 no campo Valor padrão.

  Neste exemplo, branches é o nome da entidade, e o valor de Entity Id precisa ser transmitido diretamente, como 4. Se a passagem de um ID de entidade único gerar um erro devido a duas chaves compostas, use a cláusula de filtro com as colunas obrigatórias

  Exemplo: operação GET para a entidade "Repositórios"

  1. Na caixa de diálogo Configure connector task, clique em Entities.
  2. Selecione "Repositórios" na lista Entity.
  3. Selecione a operação GET e clique em Concluído.
  4. Defina o ID da entidade como 4, que é a chave a ser transmitida. Para definir o ID da entidade, em Na seção Task Input da tarefa Connectors, clique em EntityId e e insira 4 no campo Valor padrão.

  Neste exemplo, Repositories é o nome da entidade, e o valor de ID da entidade precisa ser transmitido diretamente, como 4. Se a transmissão de um único ID de entidade gerar um erro devido a duas chaves compostas, use a cláusula de filtro com as colunas necessárias.

  É possível executar operações GET nas seguintes entidades:

  CommitComments, Commits, IssueAssignees, Labels, Milestones, PullRequestReviews, PullRequests, PullRequestComments, ReleaseAssets, Release, Topics, Users, Collaborators, Organizations e Licenses.

  Exemplo: operação CREATE para a entidade "Issues"

  1. Na caixa de diálogo Configure connector task, clique em Entities.
  2. Selecione "Issues" na lista Entity.
  3. Selecione a operação Create e clique em Concluído.
  4. Na seção Entrada da tarefa da tarefa Connectors, clique em connectorInputPayload e insira um valor semelhante ao seguinte no campo Default Value:

          {
       "Title": "Google_Cloud_GitHub_Issues_Create",
       "Body": "Please check hence raising the Feature Request for the same."
          }

     A execução desse exemplo retorna uma resposta semelhante à seguinte no campo Conector variável de saída connectorOutputPayload da tarefa:

          {
       "Id": "I_kwDOLywhW86Sd-xF"
          } 

  Exemplo: operação CREATE para a entidade "PullRequests"

  1. Na caixa de diálogo Configure connector task, clique em Entities.
  2. Selecione PullRequests na lista Entity.
  3. Selecione a operação Create e clique em Concluído.
  4. Na seção Entrada da tarefa da tarefa Connectors, clique em connectorInputPayload e insira um valor semelhante ao seguinte no campo Default Value:

          {
       "BaseRefName": "main",
       "HeadRefName": "New_Branch",
       "Title": "DEMO_Google_Cloud_PULLRequest",
       "Body": "This is demo Google_Cloud pull"
          }

     A execução desse exemplo retorna uma resposta semelhante à seguinte na variável de saída connectorOutputPayload da tarefa do conector:

           {
       "Id": "PR_kwDOLywhW8537gcA"
           } 

  Exemplo: operação CREATE para a entidade "Repositórios"

  1. Na caixa de diálogo Configure connector task, clique em Entities.
  2. Selecione repositórios na lista Entity.
  3. Selecione a operação Create e clique em Concluído.
  4. Na seção Entrada da tarefa da tarefa Connectors, clique em connectorInputPayload e insira um valor semelhante ao seguinte no campo Default Value:

          {
       "Name": "Google_Cloud_DEMO_REPO",
       "OwnerId": "O_kgDOCaxLsg",
       "Visibility": "PUBLIC"
          }

     A execução desse exemplo retorna uma resposta semelhante à seguinte na variável de saída connectorOutputPayload da tarefa do conector:

           {
       "Id": "R_kgDOMhWBEQ"
           } 

  Exemplo: operação UPDATE para a entidade "Issues"

  1. Na caixa de diálogo Configure connector task, clique em Entities.
  2. Selecione "Issues" na lista Entity.
  3. Selecione a operação UPDATE e clique em Concluído.
  4. Na seção Entrada da tarefa da tarefa Connectors, clique em connectorInputPayload e insira um valor semelhante ao seguinte no campo Default Value:

          {
       "Title": "New_Updated_Google_Cloud_Issue",
       "Body": "Newly Updated from Google_Cloud"
          }

  5. Defina o valor de entityId como I_kwDOLywhW86Sd-xF. Para definir o valor de filterOverride, Clique em entityId e digite I_kwDOLywhW86Sd-xF no campo Valor padrão. .

     A execução desse exemplo retorna uma resposta semelhante à seguinte no campo Conector variável de saída connectorOutputPayload da tarefa:

          {
       "Id": "I_kwDOLywhW86Sd-xF"
          }

  Exemplo: operação UPDATE para a entidade "PullRequests"

  1. Na caixa de diálogo Configure connector task, clique em Entities.
  2. Selecione PullRequests na lista Entity.
  3. Selecione a operação UPDATE e clique em Concluído.
  4. Na seção Entrada de tarefa da tarefa Conectores, clique em connectorInputPayload e insira um valor semelhante ao seguinte no campo Campo Default Value:

           {
       "Title": "Updated_Google_Cloud_PULL",
       "Body": "Update New pull Body"
           }

  5. Defina o valor de entityId como PR_kwDOLywhW8537gcA. Para definir o valor de filterClause, clique em entityId e insira PR_kwDOLywhW8537gcA no campo Valor padrão.

     A execução desse exemplo retorna uma resposta semelhante à seguinte no campo Conector variável de saída connectorOutputPayload da tarefa:

           {
       "Id": "PR_kwDOLywhW8537gcA"
           } 

  Exemplo: operação UPDATE para entidade "Repositórios"

  1. Na caixa de diálogo Configure connector task, clique em Entities.
  2. Selecione repositórios na lista Entity.
  3. Selecione a operação UPDATE e clique em Concluído.
  4. Na seção Entrada de tarefa da tarefa Conectores, clique em connectorInputPayload e insira um valor semelhante ao seguinte no campo Campo Default Value:

           {
       "Name": "Updated_New_Google_Cloud_Repo"
           } 

  5. Defina o valor de entityId como R_kgDOMhWBEQ. Para definir o valor de filterOverride, Clique em entityId e digite R_kgDOMhWBEQ no campo Valor padrão. .

     A execução desse exemplo retorna uma resposta semelhante à seguinte na variável de saída connectorOutputPayload da tarefa do conector:

           {
       "Id": "R_kgDOMhWBEQ"
           } 

  Exemplo: operação DELETE para a entidade "PullRequestReviewRequests"

  1. Na caixa de diálogo Configure connector task, clique em Entities.
  2. Selecione PullRequestReviewRequests na lista Entity.
  3. Selecione a operação DELETE e clique em Concluído.
  4. Defina o valor para filterCláusula, clique em filterCláusula e digite PullRequestId= 'PR_kwDOLywhW85yNWPa' and RequestedReviewerUserId= 'U_kgDOCebPLA' no campo Valor padrão. .
  Observação:

  PullRequestReviewRequests é o nome da tabela.

  O valor de filter explica precisa ser transmitido diretamente. Por exemplo, PullRequestId= 'PR_kwDOLywhW85yNWPa' e RequestedReviewerUserId= 'U_kgDOCebPLA'. Aqui, PullRequestId= 'PR_kwDOLywhW85yNWPa' e RequestedReviewerUserId= 'U_kgDOCebPLA' é o valor da chave primária exclusiva, que precisa ser transmitido.

Usar a conexão do GitHub em uma integração

Depois que você cria a conexão, ela fica disponível nos Apigee Integration e Application Integration. Você pode usar a conexão em uma integração pela tarefa Conectores.

• Para entender como criar e usar a tarefa Conectores na integração da Apigee, consulte a Tarefa Conectores.
• Para entender como criar e usar a tarefa "Conectores" na integração de aplicativos, consulte Tarefa "Conectores".

Receber ajuda da comunidade do Google Cloud

Poste suas dúvidas e converse sobre esse conector na comunidade do Google Cloud em Fóruns do Cloud.

A seguir

• Entenda como suspender e retomar uma conexão.
• Entenda como monitorar o uso do conector.
• Saiba como acessar os registros do conector.