每次发布,尽在手机
发布悄无声息地失败时,你会在几秒内得知,远早于用户反馈网站故障。
适配任何流水线
GitHub Actions、GitLab CI、Jenkins 和 CircleCI 都只需在流水线末尾添加一个步骤。
成功或失败
成功、失败或两者都发送。在 if: failure() 条件下运行通知步骤,即可只接收发布失败的告警。
部署上下文
在消息中加入提交、分支、环境和运行链接,让你清楚知道发布了什么。
按环境划分频道
为每个环境创建独立的应用,让 prod、staging 和 preview 的部署各自拥有独立的频道。
任务结束即时通知
任务结束时推送立即送达,你可以直接关闭流水线页面。
零配置
在任务中调用一次 CLI 或 curl 即可,无需安装任何 Slack 机器人。
三步开启部署告警
获取密钥或 Webhook URL
创建用于 CLI 或 curl 调用的 API 密钥,或创建一个 Webhook 并复制其接收 URL。
添加步骤或 Webhook
在流水线中添加一个通知步骤,或将接收 URL 粘贴到 Vercel 或 Netlify 的部署通知设置中。
放心发布
发布一次版本,手机就会震动,并显示结果、提交和环境信息。
每次部署都发送通知
1. CI/CD 流水线(CLI 或 curl)
在 GitHub Actions、GitLab CI、Jenkins 或 CircleCI 任务的末尾添加一个步骤。使用 CLI:
pocketalert send -t "Deploy succeeded" -m "prod @ v2.4.0"
或者直接调用消息 API 的 curl 命令,这样运行器上无需安装任何东西:
curl -X POST "https://api.pocketalert.app/v1/messages" \
-H "Token: YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{"title":"Deploy succeeded","message":"prod @ v2.4.0","level":"silent"}'
2. Vercel 或 Netlify(Webhook)
创建一个 Webhook,让 Vercel 或 Netlify 将其自身的部署数据 POST 到 Pocket Alert。message 字段是一个 GJSON 模板,用于将它们的字段映射到推送内容中:
curl -X POST "https://api.pocketalert.app/v1/webhooks" \
-H "Token: YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{"name":"Vercel deploy","message":"%type%: %payload.project.name% on %payload.deployment.target%","application_id":"qm47b9pzxzxg"}'
你会获得一个类似 https://p4a.me/wh/1234abcd 的接收 URL。将其粘贴到 Vercel 的 Webhook 设置中(事件如 deployment.succeeded)。对于 Netlify,将其添加为部署通知的出站 Webhook,并映射其字段,例如 %name% is %state% on %branch%。
详情请参阅 Webhook 设置文档,其中涵盖消息 API 和 GJSON 字段映射。
常见问题解答
在 GitHub Actions、GitLab CI、Jenkins 或 CircleCI 的流水线末尾添加一个通知步骤。运行 Pocket Alert CLI 或一条 curl 命令,任务结束后部署结果会立即以推送通知的形式送达。
可以。根据任务状态发送成功或失败的消息,并仅在 if: failure() 条件下运行通知步骤,这样你收到的就只有发布失败的告警。
在消息正文中加入提交、分支、环境和流水线链接。告警会告诉你发布了什么、发布到哪里,并直接链接到此次运行记录。
只要能运行命令的工具都可以使用:GitHub Actions、GitLab CI、Jenkins、CircleCI、Bitbucket Pipelines,或普通的部署脚本。对于 Vercel 和 Netlify,创建一个 Pocket Alert Webhook,并将其接收 URL 粘贴到它们的部署通知设置中。
为 prod、staging 和 preview 分别创建独立的应用。生产环境的部署会进入单独的频道,你可以一眼区分不同的发布。
可以。对部署失败的消息使用 level=critical:Android 会将其发布到专用渠道,绕过勿扰模式;iPhone 会以时效性通知的形式显示,并能穿透专注模式。日常的成功提示可以使用 level=silent 发送,这样它们会保留在历史记录中,但不会震动提醒。