Vertra + GitHub Actions

Do seu push ao próximo deploy.

Seu código já está no GitHub. Inclua a Action oficial no workflow e atualize sua aplicação na Vertra sem sair do fluxo de desenvolvimento.

Configurar meu workflow Ver no GitHub

01
Push na main
git push
02
Checkout do repositório
actions/checkout
03
Envio para a Vertra
vertracloud/github-action
04
Reinício da aplicação
restart: true

Seu repositório · Seu workflow · Sua aplicação.github/workflows/deploy.yml

Pronto para o próximo push

Um workflow. Menos uma tarefa manual.

Salve este arquivo no repositório para enviar o projeto a cada push na main. A aplicação precisa estar criada na Vertra antes do primeiro deploy.

.github/workflows/deploy.yml

name: Deploy
on:
  push:
    branches: [main]
permissions:
  contents: read
jobs:
  deploy:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
      - uses: vertracloud/github-action@v1
        with:
          api-key: ${{ secrets.VERTRA_API_KEY }}
          app-id: ${{ secrets.VERTRA_APP_ID }}

Cadastre VERTRA_API_KEY e VERTRA_APP_ID em Settings → Secrets and variables → Actions no seu repositório. Nunca coloque a chave diretamente no arquivo.

api-key: Obrigatório. Chave de API armazenada em um GitHub Secret.
app-id: Obrigatório. ID da aplicação existente que receberá os arquivos.
path: Opcional. Diretório do projeto. O padrão é a raiz do repositório (.).
restart: Opcional. Reinicia após o envio. O padrão é "true".

No ritmo do seu projeto

Você escolhe quando publicar.

Encaixe o deploy nas etapas que já fazem parte do seu desenvolvimento.

Depois dos seus testes

Adicione a etapa de deploy depois dos testes e do build do seu workflow, para enviar apenas quando as etapas anteriores passarem.

Também em monorepos

Use path para enviar apenas o diretório da aplicação, como apps/api, sem empacotar o repositório inteiro.

Credenciais em secrets

Autentique com uma chave de API guardada no GitHub Secrets. As permissões continuam sob seu controle.

Arquivos e reinício

A Action compacta o projeto, respeita .vertraignore e .vertracloudignore e permite escolher se a aplicação reinicia após o envio.

Configuração inicial

Três passos. Depois, é só seguir seu fluxo.

Prepare a aplicação

Crie a aplicação na Vertra, copie seu ID e gere uma chave de API com as permissões necessárias para envio e reinício.

Cadastre os secrets

No repositório, salve a chave em VERTRA_API_KEY e o ID em VERTRA_APP_ID, na área de secrets do GitHub Actions.

Adicione o workflow

Crie .github/workflows/deploy.yml com o exemplo acima. Faça um push na main e acompanhe a execução na aba Actions.

FAQ

Antes de automatizar.

A Action cria uma aplicação nova?

Não. Ela atualiza os arquivos de uma aplicação existente, identificada pelo app-id. Crie a aplicação no painel antes de executar o workflow.

Posso mudar o gatilho do deploy?

Sim. O exemplo usa push na main, mas você pode configurar os eventos do GitHub Actions de acordo com o seu processo, como tags ou execução manual.

O que acontece com os arquivos antigos?

Os arquivos enviados sobrescrevem os de mesmo caminho. Arquivos que já existem na aplicação e não estão no envio permanecem lá; o deploy não faz uma sincronização com exclusão.

Posso enviar sem reiniciar?

Sim. Defina restart como "false". O padrão é "true", que reinicia a aplicação depois do envio. Continuam valendo os limites de upload e do plano.