technosophos/github-notify

GitHub Notify：简单发送GitHub状态更新

该工具用于向GitHub仓库的提交（或类似提交的对象）设置状态更新，提供简洁的命令行方式发送此类更新，适用于在Docker容器中使用。

核心功能

• 支持设置GitHub提交状态（成功、失败、错误、pending）
• 通过环境变量配置所有参数，适配容器化场景
• 可与Brigade脚本集成，用于自动化工作流

使用场景

• CI/CD流程中向GitHub反馈构建或测试状态
• 自动化任务完成后更新GitHub提交状态
• Brigade脚本中的状态通知环节

配置说明

需在容器中设置以下环境变量：

# 必填：GitHub仓库（格式：用户名/仓库名）
GH_REPO="technosophos/github-notify"
# 必填：状态类型（可选值：success、failure、error、pending）
GH_STATE="success"
# 必填：GitHub OAuth令牌（需在GitHub账户设置中生成）
GH_TOKEN="REDACTED"
# 推荐：待更新的提交哈希（默认值：master）
GH_COMMIT="62727511e4c87b2d8a5f0ea9d0288bb74ce7dc2d"
# 可选：显示给用户的简短描述
GH_DESCRIPTION="执行复杂任务"
# 可选：用于分组通知的简短标识
GH_CONTEXT="ci"
# 可选：用户可点击查看详情的URL
GH_TARGET_URL="http://technosophos.com"

部署示例

Docker Run命令

bash
docker run -e GH_REPO="your-username/your-repo" -e GH_STATE="success" -e GH_TOKEN="your-token" -e GH_COMMIT="your-commit-hash" technosophos/github-notify:latest

与Brigade集成

在Brigade脚本中使用该镜像：

javascript
const { events, Job } = require("brigadier");

events.on("exec", (e, p) => {
  var ghJob = new Job("github-notify", "technosophos/github-notify:latest");
  ghJob.env = {
    GH_REPO: p.repo.name,
    GH_STATE: "success",
    GH_DESCRIPTION: "Brigade执行成功！",
    GH_CONTEXT: "brigade",
    GH_TOKEN: p.secrets.githubToken, // 需在项目配置中设置此密钥
    GH_COMMIT: "68f9a8f8efab12e6bb8fc4c2b3f2ac6b7051df8f" // 示例提交哈希
  };
  ghJob.run().then(() => console.log("状态已更新。"));
});

项目配置中需设置密钥：

yaml
secrets:
  githubToken: 你的实际GitHub令牌