Pular para o conteúdo
Latchkey
Menu da documentação

Quickstart: do zero ao dashboard

Faça login com o GitHub, escolha um plano, 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
02Escolha um planoTeste de 30 dias, sem cartão no Developer/Launch
03Instale o appNa sua organização do GitHub
04Selecione reposEscolha o que o Latchkey monitora
05DashboardBackfill + análise de IA começam automaticamente

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 passo 3 acontece sob esta identidade, e a pessoa que instala o app se torna o owner do workspace. Se você for interrompido em algum momento, basta fazer login novamente; o onboarding retoma de onde você parou.

Escolha um plano

Novas contas são levadas ao seletor de planos. Todo plano começa com um teste gratuito de 30 dias. Developer e Launch começam imediatamente sem cartão de crédito; Scale passa primeiro pelo checkout, com o teste aplicado ali. A diferença prática nesta etapa é quantos repositórios você pode monitorar: 1 no Developer, até 10 no Launch, até 40 no Scale. Não complique a escolha: você pode trocar de plano depois, e o teste não reinicia quando você faz isso. A comparação completa está em Planos e o teste gratuito.

Instale o GitHub App

O passo 1 do onboarding, "Conectar o GitHub", envia você ao GitHub para instalar o app do Latchkey: clique em Autorizar o Latchkey e o GitHub abre a página de instalação. 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 onboarding 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 (1 no Developer, 10 no Launch, 40 no Scale). 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 você pode pular esta etapa por completo e adicionar repositórios depois pelo dashboard. Orientações para escolher dentro de um limite de plano estão em Gerenciando repositórios.

Finalize e abra o dashboard

O passo 3 confirma sua configuração e leva você ao dashboard. Na sua primeira visita, um breve tour guiado apresenta cada área; 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, e a análise de IA é iniciada automaticamente assim que ele termina. 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

Nos planos Launch e Scale, 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: onboardingLogin, escolha de plano, instalação do GitHub App, 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
04A análise de IA é iniciadaAssim que o backfill termina, o agente de otimização analisa seus workflows; a página Insights mostra um banner de processamento enquanto ele trabalha
05As primeiras recomendações aparecemNa página Optimization Insights, cada uma com um índice de confiança; uma notificação dispara se você tiver esse tipo habilitado
06Tempo 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#