Como Criar um Aplicativo GitHub Self-Hosted

Se você está usando o Bencher Cloud, então você pode simplesmente se registrar ou entrar usando o botão GitHub.

Para o Bencher Self-Hosted, você precisará ter um plano Bencher Plus Enterprise, criar seu próprio GitHub App e atualizar sua configuração do console e configuração do servidor API.

Criar um apllicativo GitHub

• Crie um aplicativo GitHub
• Nome do aplicativo GitHub
  • Escolha um nome único (ex: Bencher para a Minha Empresa)
• URL da página inicial
  • Defina-o para sua URL do Console Bencher Self-Hosted (ex: https://bencher.example.com)
• Identificando e autorizando usuários
  • URL de callback
    • Defina o URL de callback para sua URL do Console Bencher Self-Hosted com o caminho /auth/github (ex: https://bencher.example.com/auth/github)
  • ✅ Expirar tokens de autorização de usuário
  • ✅ Solicitar autorização do usuário (OAuth) durante a instalação
  • ✅ Ativar Fluxo de Dispositivo
• Webhook
  • ❌ Ativo - Desmarque esta caixa
• Permissões
  • Permissões da conta
    • Endereços de e-mail: Somente leitura
• Onde este aplicativo GitHub pode ser instalado?
  • 🔘 Qualquer conta
• Clique Criar aplicativo GitHub
• Agora em Geral para o aplicativo recém-criado
• Anote o ID do Cliente (ex: Iv1.12864abcd1232048)
• Segredos do cliente
  • Clique Gerar um novo segredo de cliente
  • Anote este segredo (ex: 00000abcd12345wxyz123456789abcdefgh0000)
• Adicione o logo PNG do Bencher em Informações de exibição
• Chaves privadas
  • Clique Gerar uma chave privada

Configuração do aplicativo GitHub

Interface do usuário do console

Defina a variável de ambiente GITHUB_CLIENT_ID quando você executar a imagem Docker do bencher-console. (ex: GITHUB_CLIENT_ID=Iv1.12864abcd1232048) Se o ID do cliente estiver faltando, então os botões do GitHub não aparecerão na UI.

Servidor API

Adicione o client_id e o client_secret à seção plus.github da configuração do servidor. Se a seção GitHub estiver faltando, então o servidor falhará em qualquer solicitação de autenticação do GitHub.

Repositórios vinculados

Atualize o servidor API e o Console do Bencher Self-Hosted para v0.6.16 ou posterior antes de alterar estas configurações.

Para que um Projeto possa vincular um repositório GitHub para suas execuções desanexadas, defina também estas configurações para o aplicativo GitHub:

• Identificando e autorizando usuários
  • URL de callback
    • Defina o primeiro URL de callback para sua URL do Console Bencher Self-Hosted com o caminho /console/github (ex: https://bencher.example.com/console/github). O GitHub envia o usuário para o primeiro URL de callback depois que ele instala o aplicativo.
    • Mantenha depois dele o URL de callback com o caminho /auth/github, para o login (ex: https://bencher.example.com/auth/github). O GitHub recusa um login cujo URL de callback não esteja na lista.
  • ✅ Solicitar autorização do usuário (OAuth) durante a instalação
• Webhook
  • ✅ Ativo - Marque esta caixa
  • URL do webhook
    • Defina-o para sua URL do Servidor API Bencher Self-Hosted com o caminho /v0/github/webhook (ex: https://api.bencher.example.com/v0/github/webhook)
  • Segredo do webhook
    • Insira um segredo aleatório e anote-o (ex: 0123456789abcdef0123456789abcdef)
• Permissões
  • Permissões do repositório
    • Conteúdo: Leitura e escrita
  • Inscrever-se em eventos
    • Deixe todos os eventos desmarcados
• Anote o slug do aplicativo, a última parte da URL de sua página pública (ex: my-bencher-app em https://github.com/apps/my-bencher-app)

Adicione o slug, a chave privada e o segredo do webhook como app à seção plus.github da configuração do servidor.

🐰 Parabéns! Você aprendeu a configurar um aplicativo do GitHub! 🎉

Adicione Bencher às Ações do GitHub ➡