Pular para o conteúdo
LatchkeyLatchkey home
Comece grátis
Menu da documentação

Quickstart: do zero ao dashboard

Faça login com o GitHub, instale o GitHub App na sua organização, selecione repositórios e veja seu primeiro analytics de CI. Leva cerca de cinco minutos.

A página de login do Latchkey
Passo 1: faça login com a conta do GitHub que tem acesso à sua organização.

Este é o caminho mais rápido do nada a um dashboard funcional do Latchkey. Nada nele toca seus repositórios ou workflows; a única alteração de código nesta página é a troca opcional de uma linha runs-on: perto do fim.

01Faça loginCom o GitHub; o teste de 30 dias começa automaticamente
02Conecte o GitHubInstale o app na sua organização do GitHub
03Selecione reposEscolha o que o Latchkey monitora
04DashboardO backfill importa ~30 dias de histórico

Antes de começar

Faça login com o GitHub

Acesse latchkey.dev/sign-in e faça login com sua conta do GitHub. Use a conta do GitHub que tem acesso à organização que você quer monitorar: a instalação do app no próximo passo acontece sob esta identidade, e a pessoa que instala o app se torna o owner do workspace. Você chega ao card Get started do dashboard ("Welcome to Latchkey"), e seu teste de 30 dias já está em andamento, sem necessidade de cartão de crédito. Se você for interrompido em algum momento, basta fazer login novamente; a configuração retoma de onde você parou.

Conecte o GitHub

O passo 1 do card Get started é Connect GitHub. Clique nele e o Latchkey envia você ao GitHub para instalar o app (uma breve tela intermediária explica antes o que vai acontecer). Quando o GitHub perguntar onde instalar, escolha sua organização (não sua conta pessoal). Você precisa de permissões de owner ou admin na organização; se você não tiver nenhuma delas, peça a um owner da organização para instalar o app ou conceder a você direitos de admin. O que o app pode e não pode acessar está descrito em Instalar o GitHub App.

Selecione repositórios para monitorar

O passo 2 do card Get started, Select repositories, abre o seletor de repositórios, que lista os repositórios da sua organização com busca e um filtro de visibilidade. Selecione os que você quer que o Latchkey monitore; o contador mostra quantos seu plano permite (10 no Launch, onde todo workspace novo começa; 1 no Developer e 40 no Scale se você trocar de plano depois). Duas coisas que vale saber enquanto você escolhe: os runners gerenciados só atendem repositórios monitorados, então inclua qualquer repo que você planeja apontar para labels latchkey-*; e o link "Skip for now, explore the dashboard first" permite adiar isso e adicionar repositórios depois pelo dashboard. Orientações para escolher dentro de um limite de plano estão em Gerenciando repositórios.

Veja o dashboard se preencher

Após a configuração, um breve tour guiado do dashboard é oferecido; você pode pulá-lo a qualquer momento. Para cada repositório que você habilitou, o Latchkey faz o backfill das execuções de workflow concluídas recentes dos últimos 30 dias, então a maioria dos times vê dados em poucos minutos; um banner de progresso é exibido enquanto o backfill roda. Se uma página parecer vazia, verifique primeiro a barra de filtros no topo: as páginas de analytics mostram dados dos repositórios que você seleciona e pedem que você escolha um se nada estiver selecionado.

Opcional: execute um job em um runner do Latchkey

Altere uma linha em qualquer workflow para experimentar um runner gerenciado e autorreparável. Depois de dar push, o job aparece como na fila no GitHub até que um runner o pegue: segundos quando um runner aquecido está disponível, cerca de 10 segundos quando um runner novo faz cold start para você. O passo a passo completo, incluindo como verificar onde o job rodou, está em Execute seu primeiro job.

.github/workflows/ci.yml
jobs:
  build:
    runs-on: latchkey-small
    steps:
      - uses: actions/checkout@v4
      - run: npm ci && npm test

Opcional: convide seu time

Em todos os planos exceto o Developer, abra Team na barra lateral do dashboard para convidar colegas por e-mail ou link compartilhável (o plano Developer é para uso individual, então convites não estão disponíveis nele). Os convites concedem a função de Admin ou Member. Veja Time e funções.

O que esperar na primeira hora#

Aqui está a sequência típica depois que você conclui o onboarding, para você saber o que é normal e o que vale uma segunda olhada:

01Minutos 0 a 5: configuraçãoLogin, conexão com o GitHub, seleção de repositórios
02O backfill começaAs execuções concluídas recentes dos últimos 30 dias são importadas para cada repositório habilitado; um banner de progresso é exibido enquanto ele roda
03Os primeiros dados chegamAs execuções do backfill aparecem nas páginas Overview, Cost e Performance, geralmente em poucos minutos
04O AI Insight entra em cenaAs descobertas são computadas a cada noite a partir dos dados das suas execuções, então as primeiras descobertas quantificadas normalmente aparecem no dia seguinte
05Tempo real a partir daquiNovas execuções de workflow chegam em fluxo via o GitHub App à medida que acontecem. Sem polling, sem atualização manual

Para onde ir a partir daqui#

Quanto tempo leva para configurar o Latchkey?

Cerca de cinco minutos: entre com o GitHub, instale o app na sua organização e selecione os repositórios. O teste de 30 dias começa sozinho, sem nenhuma etapa extra.

Quanto tempo até eu ver dados no painel?

Minutos. Uma importação traz os últimos 30 dias de execuções concluídas assim que você seleciona os repositórios, então os painéis de custo e desempenho se preenchem sem esperar por novos builds. As descobertas do AI Insight chegam na próxima execução noturna.

Como executo meu primeiro job em um runner Latchkey?

Mude uma linha no workflow: troque o valor de runs-on por latchkey-small. Seus steps, actions, secrets, services e matrix continuam exatamente como estão, e os labels hospedados no GitHub seguem funcionando no mesmo workflow, então dá para migrar um job por vez.

References