GitHub Actions

Faça um workflow concluído faça o seu celular vibrar.

O Pocket Alert envia os resultados do GitHub Actions para o seu celular como notificações push. Adicione um passo com curl a um workflow e, quando um build, deploy ou release terminar, o resultado chega ao seu iPhone ou Android em menos de um segundo, sem precisar ficar olhando a aba Actions.

Push em <1sChave como secretUm passo com curlAtualizado em
Recursos

Da execução do workflow à tela de bloqueio

Seu workflow já sabe quando um job termina. O Pocket Alert transforma esse momento em uma notificação push que você não consegue ignorar.

Um passo no seu workflow

Uma única chamada curl para a API de mensagens transforma qualquer passo do workflow em uma notificação push. Sem configuração de runner e sem serviço extra.

Chave como secret do repositório

Leia sua chave de API de ${{ secrets.POCKETALERT_API_KEY }} para que ela fique fora dos logs e possa ser renovada pelo painel.

Alerte pelos resultados que você escolher

Combine if: failure() e if: success() para enviar builds com falha e deploys bem-sucedidos como mensagens separadas e claramente identificadas.

Um canal por repositório

Cada aplicativo tem seu próprio ID, então as execuções por repositório e por ambiente ficam em canais separados.

Entrega em menos de um segundo

O passo dispara no momento em que o job termina, então o resultado chega ao seu celular em menos de um segundo.

Contexto completo da execução

Inclua github.repository, github.sha e github.workflow na mensagem para saber exatamente qual execução foi.

Primeiros passos

Três passos para receber alertas do GitHub Actions no celular

1

Crie um aplicativo

Adicione um aplicativo no Pocket Alert e salve sua chave de API como o secret do repositório POCKETALERT_API_KEY.

2

Configure o passo

Adicione um passo de notificação que faz curl na API de mensagens, usando if: failure() e if: success() para escolher os resultados.

3

Mapeie e envie

Inclua repo, sha e workflow na mensagem. A próxima execução faz o seu celular vibrar.

Envie alertas do GitHub Actions para o seu celular

1. Crie um aplicativo e salve sua chave de API

Adicione um aplicativo no Pocket Alert e copie sua chave de API. Salve-a como um secret do repositório chamado POCKETALERT_API_KEY em Configurações → Secrets and variables → Actions.

2. Adicione um passo de notificação que chama a API de mensagens

- name: Notify on failure
  if: failure()
  run: |
    curl -X POST "https://api.pocketalert.app/v1/messages" \
      -H "Token: ${{ secrets.POCKETALERT_API_KEY }}" \
      -H "Content-Type: application/json" \
      -d '{"title":"Build failed","message":"${{ github.workflow }} on ${{ github.ref_name }} (${{ github.sha }})","level":"high"}'

- name: Notify on success
  if: success()
  run: |
    curl -X POST "https://api.pocketalert.app/v1/messages" \
      -H "Token: ${{ secrets.POCKETALERT_API_KEY }}" \
      -H "Content-Type: application/json" \
      -d '{"title":"Deploy succeeded","message":"${{ github.repository }}@${{ github.sha }}"}'

3. Direcione para um aplicativo específico

Adicione application_id ao corpo para enviar a notificação para um único app (encontre o TID no painel):

-d '{"title":"Release shipped","message":"${{ github.repository }} ${{ github.ref_name }}","application_id":"qm47b9pzxzxg"}'

A documentação de primeiros passos mostra todos os campos que a API de mensagens aceita.

FAQ

Dúvidas respondidas

Adicione um passo que executa curl em https://api.pocketalert.app/v1/messages com sua chave de API no cabeçalho Token. Coloque-o no fim do job para que um deploy concluído ou um build com falha envie a notificação direto para o seu celular.

Guarde sua chave de API como um secret do repositório e leia com ${{ secrets.POCKETALERT_API_KEY }}, enviada no cabeçalho Token. A chave nunca aparece nos logs, e você pode renová-la pelo painel do Pocket Alert.

Use if: failure() e if: success() em dois passos separados. Um build com falha dispara uma mensagem, e um deploy bem-sucedido dispara outra, para que você conecte apenas os resultados que importam para você.

Crie um aplicativo para cada repositório ou ambiente. Os workflows de frontend, backend e release chegam em canais separados que você pode silenciar de forma independente.

Use o contexto da execução, como ${{ github.repository }}, ${{ github.sha }} e ${{ github.workflow }}, no corpo da mensagem para que a notificação informe exatamente qual execução terminou.

O passo chama https://api.pocketalert.app/v1/messages com um cabeçalho Token e um corpo JSON com title e message. Adicione application_id para direcionar a notificação a um aplicativo específico.

Adicione "level":"high" ao corpo do passo de falha e a notificação atravessa o modo Foco no iPhone e toca de forma destacada no Android; "level":"critical" vai além e ignora totalmente o modo Não perturbe. Os avisos de deploy bem-sucedido podem ser enviados com "level":"silent", para aparecer no histórico sem vibrar.

Saiba que o deploy deu certo sem ficar acompanhando a execução.

Crie um aplicativo, pegue sua chave de API e adicione o passo do Pocket Alert ao seu workflow.