GitHub Actions

让一次完成的工作流 让你的手机震动。

Pocket Alert 会将 GitHub Actions 的运行结果以推送通知的形式发送到你的手机。在工作流中添加一个 curl 步骤,构建、部署或发布完成后,结果会在一秒内送达你的 iPhone 或 Android,无需再盯着 Actions 页面。

<1 秒 内推送密钥存为 Secret一个 curl 步骤更新于
功能

从工作流运行到锁屏通知

你的工作流早已知道任务何时结束。Pocket Alert 会把这一刻变成你无法错过的推送。

工作流中只需一个步骤

对消息 API 进行一次 curl 调用,就能把工作流中的任意步骤变成推送。无需配置运行器,也无需额外服务。

将密钥存为仓库 Secret

从 ${{ secrets.POCKETALERT_API_KEY }} 读取 API 密钥,使其不会出现在日志中,并可在控制台中轮换。

只对你选择的结果告警

搭配 if: failure() 和 if: success(),将构建失败和部署成功分别作为清晰标注的独立消息推送。

每个仓库一个频道

每个应用都有自己的 ID,因此按仓库或按环境的运行结果会保存在不同的频道中。

亚秒级送达

任务一结束,步骤就会立即触发,结果在不到一秒内送达你的手机。

完整的运行上下文

将 github.repository、github.sha 和 github.workflow 写入消息,让你准确知道是哪一次运行。

快速开始

三步在手机上收到 GitHub Actions 告警

1

创建应用

在 Pocket Alert 中添加一个应用,并将 API 密钥保存为仓库 Secret POCKETALERT_API_KEY。

2

配置步骤

添加一个通知步骤,用 curl 调用消息 API,并使用 if: failure() 和 if: success() 选择需要通知的结果。

3

映射并发送

将仓库、提交哈希和工作流信息写入消息。下一次运行就会让你的手机震动。

将 GitHub Actions 告警发送到你的手机

1. 创建应用并保存 API 密钥

在 Pocket Alert 中添加一个应用,并复制你的 API 密钥。在 Settings → Secrets and variables → Actions 中,将其保存为名为 POCKETALERT_API_KEY 的仓库 Secret。

2. 添加调用消息 API 的通知步骤

- 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. 路由到指定应用

在请求体中添加 application_id,将推送发送到某个应用(在控制台中查找 TID):

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

请查看入门文档,了解消息 API 支持的所有字段。

常见问题

常见问题解答

添加一个步骤,在 Token 请求头中带上你的 API 密钥,用 curl 调用 https://api.pocketalert.app/v1/messages。把它放在任务的末尾,这样部署完成或构建失败都会直接推送到你的手机。

将 API 密钥保存为仓库 Secret,并通过 ${{ secrets.POCKETALERT_API_KEY }} 读取,然后放在 Token 请求头中发送。密钥不会出现在日志中,你也可以在 Pocket Alert 控制台中轮换密钥。

在两个独立的步骤上分别使用 if: failure() 和 if: success()。构建失败时发送一条消息,部署成功时发送另一条,你可以只为关心的结果设置通知。

为每个仓库或环境分别创建一个应用。前端、后端和发布工作流会进入不同的频道,你可以单独静音。

在消息正文中引用 ${{ github.repository }}、${{ github.sha }} 和 ${{ github.workflow }} 等运行上下文,这样推送内容就能准确告诉你哪次运行已完成。

该步骤会调用 https://api.pocketalert.app/v1/messages,请求头中包含 Token,请求体为包含 title 和 message 的 JSON。添加 application_id 可将推送发送到指定应用。

在失败步骤的请求体中添加 "level":"high",推送会在 iPhone 上穿透专注模式,在 Android 上醒目提醒;"level":"critical" 则会完全绕过勿扰模式。部署成功的提醒可以使用 "level":"silent",消息会进入历史记录,但不会震动。

无需盯着运行记录,也能知道部署成功了。

创建一个应用,获取你的 API 密钥,然后把 Pocket Alert 步骤添加到工作流中。