IBM Cloud Docs
Configurando o GitHub

Configurando o GitHub

O GitHub é um serviço de hospedagem baseado na web para repos Git. É possível ter ambas as cópias local e remota de seus repos, o que facilita a colaboração.

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:

  1. 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ê está configurando esta integração de ferramentas no IBM Cloud Público, você deve autorizar IBM Cloud para acessar GitHub escolhendo OAuth ou Personal Access Token.

    • Se você escolher OAuth, clique em Autorizar para ir até o website 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:user e workflow.

  2. Se estiver usando um repositório em seu próprio servidor GitHub Enterprise, na seção Configurable Integrations (Integrações configuráveis), clique em Custom Server (Servidor personalizado).

    a. Digite um título para o servidor GitHub customizado, especifique a URL raiz 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.

  3. 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:

  1. No console IBM Cloud, clique no ícone de hambúrguer 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. Como alternativa, na página Visão Geral do seu app, no cartão Entrega contínua, clique em Visualizar a cadeia de ferramentas. Em seguida, clique em Visão geral.

  2. Clique em Incluir ferramenta.

  3. Na seção Integrações de ferramenta, clique em GitHub.

  4. Clique no servidor GitHub que você deseja usar.

  5. 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.

  6. 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.

  7. 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.

  8. Se quiser usar o Issues do GitHub para rastreamento de problemas, marque a caixa de seleção Ativar o GitHub Issues.

  9. 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. Para obter mais informações, consulte Rastrear onde seu código é implantado com cadeias de ferramentas.

  10. Clique em Criar integração.

  11. 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.

  12. 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.

Configuração GitHub usando a API

A integração de ferramentas do GitHub suporta os seguintes parâmetros de configuração que você pode usar com a API HTTP API e SDKs quando você criar, reade update integrações de ferramentas.

Você deve especificar a propriedade tool_type_id no corpo da solicitação com o valor githubconsolidated.

Parâmetros de integração da ferramentaGitHub
Parâmetro Uso Tipo Argumento de Terraform Descrição
api_root_url opcional, atualizável Sequência api_root_url A URL da raiz da API para o servidor GitHub.
api_token opcional, atualizável Senha api_token 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 Configure o método de autenticação para usar para acessar o provedor Git.
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
default_branch opcional, atualizável Sequência default_branch O ramo padrão do repo Git.
enable_traceability opcional, atualizável, ' Default: false Booleano enable_traceability Defina esse valor como " true para rastrear a implantação de alterações de código criando tags, rótulos e comentários em commits, pull requests e problemas 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.
has_issues opcional, atualizável, ' Default: true Booleano toolchain_issues_enabled 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.
integration_owner opcional, atualizável Sequência integration_owner 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.
private_repo opcional, imutável, ' Default: false Booleano private_repo 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 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 A URL do repo GitHub para esta integração de 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.
root_url opcional, atualizável Sequência root_url A URL raiz do servidor. por exemplo, https://github.example.com
source_repo_url opcional, imutável Sequência source_repo_url A URL do repo que você está forcando 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
token_url opcional, atualizável Sequência token_url A URL do token que é usada para autorizar com o servidor GitHub.
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.