Configurando o GitHub como repositório de origem em cadeias de ferramentas
Continuous Delivery será descontinuado nas seguintes regiões em 12 de fevereiro de 2027: au-syd, ca-tor, us-east. O Code Risk Analyzer também será descontinuado em todas as regiões nessa data. Se uma região não apresentar uso ativo desses recursos, os recursos nessa região poderão ser descontinuados mais cedo e deixar de aceitar novas instâncias. Saiba mais
Configure o GitHub em sua cadeia de ferramentas do IBM Cloud para gerenciar código-fonte, colaborar por meio de pull requests e acionar execuções de pipeline quando houver alterações no código.
O GitHub Enterprise é um serviço de hospedagem no local, baseado na web para repositórios Git.
O GitHub Issues é uma ferramenta de controle que mantém seu trabalho e seus planos todos em um lugar. Ele é integrado a seu repo de desenvolvimento para que possa focar em tarefas importantes.
É possível configurar o GitHub como uma integração de ferramenta em sua cadeia de ferramentas para que seja possível gerenciar o código-fonte em um repositório novo ou existente em GitHub.com ou na instância do GitHub Enterprise de sua empresa. Envolva-se na codificação social por meio de wikis, rastreamento de problemas e solicitações pull.
Se estiver configurando esta integração de ferramenta conforme estiver criando a cadeia de ferramentas, siga estas etapas:
-
Se você estiver armazenando seu código-fonte em um repositório GitHub, na seção Integrações configuráveis, clique em GitHub. Se você estiver configurando a integração desta ferramenta no IBM Cloud Public, será necessário autorizar IBM Cloud a acessar GitHub, selecionando OAuth, “Token de acesso pessoal ” ou “GitHub App ”.
-
Se você escolher OAuth, clique em Authorize (Autorizar ) para acessar o site GitHub. Se você não tiver uma sessão do GitHub ativa, será solicitado a efetuar login. Clique em Autorizar aplicativo para permitir que o IBM Cloud acesse sua conta GitHub. Se você tiver uma sessão do GitHub ativa, mas não inseriu sua senha recentemente, poderá ser solicitado a inserir sua senha do GitHub para confirmar.
-
Se você optar pelo Token de Acesso Pessoal, você deve inserir o token de acesso pessoal para usar para autorizar com o GitHub para clonar recompos e executar outras ações em seu nome. Se você não tiver um token de acesso pessoal, pode seguir a documentação no website do GitHub para criar um. Certise-se de que seu token de acesso pessoal tenha os direitos
repo,delete_repo,read:usereworkflow. -
Se você escolher um aplicativ GitHub, o IBM Cloud utiliza uma instalação do aplicativo GitHub para se autenticar no GitHub em seu nome, em vez de um token OAuth. GitHub Os aplicativos oferecem um controle de permissões mais detalhado e não dependem das credenciais individuais dos usuários. Escolha um dos seguintes métodos:
-
Gerenciado — Use o aplicativo “ GitHub ” fornecido pelo IBM, que vem pré-configurado para o seu servidor GitHub. Clique em “Autorizar” para ser redirecionado para GitHub,, onde você aprovará o acesso do aplicativo à sua conta.
-
Personalizado — Traga seu próprio aplicativo “ GitHub ”. Insira a App ID e a chave privada (no formato PEM ) de um aplicativo GitHub que você tenha registrado e instalado em seus repositórios. O aplicativo deve estar instalado em qualquer repositório que você queira usar com essa integração. Para obter mais informações sobre como criar um aplicativo do tipo “ GitHub ”, consulte a documentação do “ GitHub ”.
-
-
-
Se você estiver usando um repositório no seu próprio servidor GitHub Enterprise, na seção “Integrações configuráveis”, clique em “Servidor personalizado ”.
a. Digite um título para o seu servidor GitHub personalizado, especifique a raiz URL para o servidor e insira seu token de acesso pessoal.
b. Se você não tiver um token de acesso pessoal, pode seguir a documentação no website do GitHub para criar um.
c. Se o seu servidor do GitHub estiver em air-gap ou não estiver acessível na Internet pública, você poderá conectar e integrar um Delivery Pipeline Private Worker para ser executado em sua própria infraestrutura do Kubernetes para acessar recursos internos ou locais. Para obter mais informações sobre Delivery Pipeline Trabalhadores privados, consulte Trabalhando com Delivery Pipeline Trabalhadores privados.
d. Se o seu servidor GitHub Enterprise tiver um aplicativo GitHub registrado, você também pode escolher o método de autenticação do aplicativo GitHub e fornecer sua App ID e chave privada, ou usar o aplicativo gerenciado, caso haja um pré-configurado para o seu servidor.
-
Revise os locais de repositório de destino padrão para os repositórios GitHub. Esses repos são clonados a partir dos mesmos repos de amostra. Se necessário, mude os nomes dos repos de destino.
Se você tiver uma cadeia de ferramentas e estiver incluindo esta integração de ferramenta nela, siga essas etapas:
-
No IBM Cloud console, clique no ícone Menu
> Automação da plataforma > Cadeias de ferramentas. Na página Cadeias de ferramentas, clique na cadeia de ferramentas para abrir a sua página de Visão geral.
-
Clique em Incluir ferramenta.
-
Na seção Integrações de ferramenta, clique em GitHub.
-
Clique no servidor GitHub que você deseja usar.
-
Se você tiver um repositório GitHub ou GitHub Enterprise e desejar usá-lo, para o tipo de repositório, clique em Existente e digite a URL.
-
Se você desejar usar um novo repositório GitHub ou GitHub Enterprise, digite um nome para o repositório, digite a URL para o repositório que está sendo clonado ou bifurcado e selecione o tipo de repositório:
a. Para criar um repositório vazio, clique em Novo.
b. Para criar uma cópia de um repositório GitHub ou GitHub Enterprise, clique em Clonar.
c. Para bifurcar um repositório GitHub ou GitHub Enterprise para que seja possível contribuir com as mudanças por meio de solicitações pull, clique em Bifurcar.
-
Se você for um usuário GitHub.com com uma conta submetida a upgrade ou se tiver selecionado um servidor GitHub Enterprise e quiser criar um novo repositório privado no servidor, marque a caixa de seleção Tornar este repositório privado.
-
Se quiser usar o Issues do GitHub para rastreamento de problemas, marque a caixa de seleção Ativar o GitHub Issues.
-
Se quiser rastrear a implementação de mudanças de código criando tags e comentários sobre confirmações, além de rótulos e comentários sobre problemas referenciados pelas confirmações, marque a caixa de seleção Rastrear a implementação de mudanças de código.
-
Clique em Criar integração.
-
Na página de visão geral da sua cadeia de ferramentas, na placa Repositórios, clique no repositório GitHub ou GitHub Enterprise com o qual deseja trabalhar. Dependendo do repositório selecionado, o website GitHub ou o repositório do GitHub Enterprise de sua empresa é aberto, no qual é possível visualizar os conteúdos do repositório.
-
Se você tiver ativado o GitHub Issues, clique em GitHub Issues para abri-lo. É possível usar essa instância do GitHub Issues para sua cadeia de ferramentas inteira, mesmo se a cadeia de ferramentas contém múltiplos repositórios GitHub ou GitHub Enterprise.
Se você não tiver privilégios de administrador para o repositório ao qual está vinculando, sua integração será limitada porque não será possível usar um webhook. Webhooks são necessários para executar automaticamente um pipeline quando uma confirmação é enviada por push para o repositório. Sem um webhook, os pipelines deverão ser iniciados manualmente.
Configurando o GitHub usando a API
A integração de GitHub ferramentas suporta os seguintes parâmetros de configuração que você pode usar com a API e os SDKs HTTP da Toolchain ao criar, ler e atualizar integrações de ferramentas.
Você deve especificar a propriedade tool_type_id no corpo da solicitação com o valor githubconsolidated.
| Parâmetro | Uso | Tipo | Argumento de Terraform | Descrição |
|---|---|---|---|---|
| url_raiz_da_api | opcional, atualizável | Sequência | url_raiz_da_api | A raiz URL da API para o GitHub servidor. |
| token_api | opcional, atualizável | Senha | token_api | O Token de Acesso Pessoal (PAT). Esse parâmetro é necessário apenas se o auth_type for configurado como pat, caso contrário, ele será ignorado. |
| auth_type | opcional, atualizável | Sequência | auth_type | Defina o método de autenticação a ser usado para acessar o provedor Git. Os valores válidos são oauth, pat e github_app. Quando “ github_app ” é especificado, a autenticação utiliza um
token de instalação do aplicativo GitHub em vez de um token de usuário OAuth ou PAT. |
| auto_init | opcional, imutável, Default: false |
Booleano | auto_init | Configure este valor para true para inicializar este repo com um arquivo readme. Este parâmetro é usado apenas quando você cria um repo. |
| blind_conexão | opcional, atualizável, Default: false |
Booleano | blind_conexão | A configuração desse valor como true significa que o servidor não é endereçável na Internet pública. O IBM Cloud não pode validar os detalhes da conexão fornecidos. Determinadas funcionalidades que requerem acesso de API ao servidor Git serão desativadas O pipeline de entrega só funcionará usando um trabalhador privado que tenha acesso à rede para o servidor git |
| ramo padrão | opcional, atualizável | Sequência | ramo padrão | O ramo padrão do repo Git. |
| enable_traceability | opcional, atualizável, Default: false |
Booleano | enable_traceability | Defina este valor como true para acompanhar a implantação de alterações no código, criando tags, rótulos e comentários em commits, pull requests e issues referenciados. |
| git_id | opcional, imutável | Sequência | git_id | Configure este valor para github para github.com, ou para o GUID de um servidor personalizado GitHub Enterprise. |
| github_app_auth_method | opcional, atualizável | Sequência | github_app_auth_method | O método de autenticação do aplicativo “ GitHub ” a ser utilizado quando auth_type é github_app. Defina como “ managed ” para usar o aplicativo “ GitHub ” fornecido pelo IBM (padrão), ou “ custom ” para fornecer suas próprias credenciais do aplicativo “ GitHub ” por meio de github_app_credential_app_id e github_app_credential_private_key. |
| github_app_credential_app_id | opcional, atualizável | Sequência | github_app_credential_app_id | A GitHub App ID para um aplicativo personalizado GitHub. Obrigatório quando github_app_auth_method é custom``. |
| chave_privada_das_credenciais_do_github_app | opcional, atualizável | Senha | chave_privada_das_credenciais_do_github_app | A chave privada RSA (formato PEM ) para um aplicativo personalizado do GitHub. Obrigatório quando github_app_auth_method é custom``. A chave é armazenada de forma criptografada. |
| has_issues | opcional, atualizável, Default: true |
Booleano | problemas_da_cadeia_de_ferramentas_ativados | Configure este valor para true para ativar problemas no repo GitHub e adiciona um cartão de ferramentas de Issues à cadeia de ferramentas. Configure o valor para false para remover a placa de integração de ferramentas
da cadeia de ferramentas. Essa configuração não impacta se as questões estão ativadas no próprio repo GitHub. |
| proprietário_da_integração | opcional, atualizável | Sequência | proprietário_da_integração | Selecione o usuário que as operações Git são realizadas como. |
| owner_id | opcional, imutável | Sequência | owner_id | O usuário ou organização do GitHub que possui o repo. Esse parâmetro é necessário quando você cria um repo, ou clone ou fork um repo. Este valor é computado quando você se liga a um repo existente. |
| repositório privado | opcional, imutável, Default: false |
Booleano | repositório privado | Configure este valor para true para fazer o repo privado quando você cria um repo ou clone ou fork um repo. Este parâmetro não é usado quando você se liga a um repo existente. |
| repo_id | opcional, imutável | Sequência | repo_id | O ID do repo GitHub. |
| repo_name | opcional, imutável | Sequência | repo_name | O nome do repositório do GitHub a ser criado. Esse parâmetro é necessário quando você cria um repo, ou clone ou fork um repo. Este valor é computado quando você se liga a um repo existente. |
| repo_url | opcional, imutável | Sequência | repo_url | O GitHubURL repositório para a integração desta ferramenta. Este parâmetro é necessário quando você se liga a um repo existente. Esse valor é computado quando você cria um repo, ou clone ou fork um repo. |
| url_raiz | opcional, atualizável | Sequência | url_raiz | A raiz URL do servidor. Por exemplo: https://github.example.com |
| url_do_repositório_fonte | opcional, imutável | Sequência | url_do_repositório_fonte | O URL repositório que você está bifurcando ou clonando. Esse parâmetro é necessário quando você forca ou clone um repo. Ele não é usado quando você cria um repo ou link para um repo existente. |
| título | opcional, atualizável | Sequência | título | O título do servidor.. por exemplo, Meu servidor GitHub Enterprise |
| url_token | opcional, atualizável | Sequência | url_token | O token URL usado para autorizar com o GitHub servidor. |
| tipo | necessário, imutável | Sequência | tipo | A operação para executar para inicializar a nova integração da ferramenta. Use new para criar um repo Git, clone para clonar um repo existente em um novo repo Git, fork para fork um repo Git existente
ou link para se vincular a um repo Git existente. |
Usando a autenticação por aplicativo do GitHub
GitHub A autenticação por aplicativo é uma alternativa aos métodos de autenticação por token de acesso de aplicativo ( OAuth ) e por token de acesso pessoal (PAT). GitHub Os aplicativos se autenticam como aplicativos, e não como usuários, o que proporciona permissões de repositório mais detalhadas, elimina a dependência de credenciais de contas de usuário individuais e gera tokens que são automaticamente renovados e limitados a repositórios específicos.
Estão disponíveis dois modos:
- Gerenciado (
github_app_auth_method: managed) - IBM Cloud utiliza um aplicativo GitHub fornecido pelo IBM, que já está pré-registrado para o seu servidor GitHub. Você autoriza o aplicativo por meio de um fluxo de consentimento do tipo “ OAuth ”, e o token usuário-servidor resultante (
ghu_) é armazenado e utilizado automaticamente. - Personalizado (
github_app_auth_method: custom) - Você pode se cadastrar e gerenciar seu próprio aplicativo “ GitHub ” em GitHub ou GitHub Enterprise. Você fornece o endereço App ID e uma chave privada RSA codificada no formato PEM. O endereço IBM Cloud utiliza essas credenciais para gerar
automaticamente tokens de acesso de instalação de curta duração (
ghs_). O aplicativo “ GitHub ” deve estar instalado em todos os repositórios que você deseja usar com essa integração.
Antes de começar com a autenticação do aplicativo personalizado “ GitHub ”
Antes de configurar a autenticação personalizada do aplicativo “ GitHub ”, siga estas etapas:
-
Crie um aplicativo “ GitHub ” na sua organização do GitHub ou na sua conta pessoal. Conceda ao aplicativo, no mínimo, as seguintes permissões de repositório:
- Conteúdo: Leitura e escrita
- Metadados: Somente leitura
- Solicitações de pull: leitura e gravação (se você usar o acompanhamento de solicitações de pull)
- Fluxos de trabalho: Leitura e gravação (se seus pipelines acionarem ações d GitHub )
-
Gere uma chave privada para o aplicativo e salve o arquivo
PEM. Você precisará dessa chave ao configurar a integração. -
Instale o aplicativo “ GitHub ” na organização ou nos repositórios aos quais sua cadeia de ferramentas terá acesso. É preciso instalar o aplicativo antes de poder validar a credencial.
Depois de configurar a integração da ferramenta com sua credencial de autenticação ( App ID ) e sua chave privada, o IBM Cloud valida a credencial chamando a API GitHub. Se o aplicativo ainda não estiver instalado em um repositório especificado, você receberá uma mensagem de erro solicitando que instale o aplicativo primeiro.