Orbit
Ligar um Repositório GitHub
Before Orbit can deploy anything from GitHub you install the Kapsule Orbit GitHub App on your GitHub account or organisation and choose which repositories it can see. This guide walks through the…
Antes de o Orbit poder implementar algo a partir do GitHub, tem de instalar a Aplicação GitHub do Kapsule Orbit na sua conta ou organização do GitHub e escolher quais repositórios pode ver. Este guia orienta-o através da instalação, seleção de um repositório, criação do projeto e o que fazer quando um repositório que espera não aparece.
Antes de Começar
Tem de ter permissão para instalar uma Aplicação GitHub na conta ou organização que detém o repositório. Numa conta pessoal isso é automático. Numa organização tem de ser proprietário ou um proprietário tem de aprovar o seu pedido de instalação nas definições da organização.
Passo 1: Instalar a Aplicação GitHub do Kapsule Orbit
- No KPanel, clique em Orbit na barra lateral esquerda.
- Clique em New project.
- Deixe o modo definido como Import Git Repo.
- No passo 1, clique em Connect GitHub.
É enviado para o GitHub para instalar a aplicação Kapsule Orbit. O GitHub pergunta onde instalar (a sua conta pessoal ou uma organização) e depois se deve conceder All repositories ou Only select repositories.
Escolha Only select repositories e assinale apenas os repositórios que planeia implementar. Pode adicionar mais tarde a partir do GitHub sem desconectar ou recriar nada no Orbit, e mantém o raio de explosão da integração pequeno.
Quando terminar, o GitHub envia-o de volta para o KPanel. O passo 1 agora mostra Just connected, e os seus repositórios carregam no passo 2.
Passo 2: Selecionar um Repositório
Os seus repositórios acessíveis aparecem como uma lista. Clique em Select naquele que deseja implementar. Os repositórios privados têm um crachá Private; o Orbit implementa repositórios públicos e privados da mesma forma.
Após seleção, o repositório mostra um crachá Selected, e uma ligação Change permite escolher um diferente.
Se um Repositório Está em Falta
O Orbit só pode listar o que a Aplicação GitHub pode ver. Se um repositório que espera não está lá:
- Clique em Reconnect GitHub no passo 1 para executar novamente o fluxo de instalação, ou abra github.com/settings/installations diretamente.
- Abra a instalação Kapsule Orbit e adicione o repositório em falta sob Repository access.
- Volte para o KPanel. A lista atualiza.
Se o painel mostra No repos accessible, a aplicação está instalada mas não lhe foram concedidos repositórios. Abra as definições da Aplicação GitHub e conceda acesso a pelo menos um.
Outras causas comuns:
- O repositório pertence a uma organização em que não instalou a aplicação. Instalar na sua conta pessoal não cobre repositórios da organização.
- Um proprietário da organização ainda não aprovou o seu pedido de instalação. Até o fazerem, a aplicação existe mas não vê nada.
- O repositório foi transferido ou renomeado depois de instalar a aplicação. Execute novamente o fluxo de instalação para atualizar o que o Orbit pode ver.
Passo 3: Configurar o Seu Projeto
Com um repositório selecionado, o passo 3 pede dois campos:
| Campo | O que faz |
|---|---|
| Project Name | O nome de apresentação no KPanel, por exemplo my-app |
| Deploy URL | O subdomínio sob kaps.run, portanto my-app torna-se my-app.kaps.run |
Clique em Create project. O Orbit clona o repositório, coloca a sua primeira compilação em fila e coloca-o na visão geral do projeto onde pode ver o fluxo de registos.
O slug de Deploy URL é definido uma vez na criação e não pode ser alterado depois. Se deseja um endereço público diferente mais tarde, anexe um domínio personalizado em vez de tentar renomear o slug. Veja Adding a Custom Domain to Your Project.
O Que o Orbit Configura Automaticamente
A criação do projeto configura push-to-deploy para si. Não há webhook para configurar manualmente:
- Pushes para o seu ramo de produção colocam uma implementação de produção em fila.
- Se Branch previews está ativado, pushes para qualquer outro ramo criam uma pré-visualização isolada em
branch-<branch-name>.kaps.run. Veja Branch Preview Deployments in Orbit. - A atividade de pedido de pull é acompanhada, portanto uma implementação de pré-visualização mostra o número de PR a que pertence.
- Fechar ou fundir um pedido de pull pausa a sua pré-visualização, e o armazenamento é reclamado dentro de cerca de um dia.
Implementações de Porta Controlada em GitHub Actions
Se executa testes em GitHub Actions pode fazer com que o Orbit os aguarde. Em Settings, depois CI required checks, introduza os nomes exatos de tarefas de Actions, separados por vírgula, por exemplo build,test,lint. Todas as verificações nomeadas devem passar antes de uma implementação de produção acionada por push prosseguir. Uma falha de CI cancela a implementação do Orbit automaticamente.
Isto aplica-se apenas ao ramo de produção.
Reconectar ou Alterar a Sua Instalação
Para alterar quais repositórios o Orbit pode ver:
- Clique em Orbit, depois em New project.
- No passo 1, clique em Reconnect para executar novamente o fluxo de instalação da Aplicação GitHub.
Ou gerencie a instalação diretamente em github.com/settings/installations. As alterações lá são apanhadas da próxima vez que o Orbit listar os seus repositórios.
Desconectar GitHub
No passo 1 de New project, clique em Disconnect.
Desconectar remove a ligação entre a sua conta Kapsule e o GitHub. Os seus projetos e o seu histórico de implementação são mantidos, e a implementação atualmente em direto continua a servir tráfego, mas as implementações acionadas por push param até se reconectar. Os ganchos de implementação continuam a funcionar, porque obtêm o cabeçalho do ramo através da ligação do fornecedor: se a ligação desaparece, uma chamada de gancho falha com um erro em vez de implementar código obsoleto.
Leitura Relacionada
- Deploying Your Project para o ciclo de implementação completo e os portões que o controlam
- Configuring Your Build Command and Output Directory se a primeira compilação falhar ou servir a coisa errada
- Connecting a GitLab Repo e Connecting a Bitbucket Repo para os outros fornecedores