rkawajiri/github-status-resource

github-status-resource

这是一个Concourse 资源，用于与https://developer.github.com/v3/repos/statuses/%E7%B1%BB%E5%9E%8B%E4%BA%A4%E4%BA%92%EF%BC%8C%E5%AE%9E%E7%8E%B0%E4%BB%A3%E7%A0%81%E6%8F%90%E4%BA%A4%E7%8A%B6%E6%80%81%E7%9A%84%E6%9F%A5%E8%AF%A2%E4%B8%8E%E6%9B%B4%E6%96%B0%E3%80%82

配置说明

• repository - 仓库所有者与名称（如 dpb587/github-status-resource）
• access_token - 具有仓库写入权限的GitHub API令牌（最小范围：repo:status）
• branch - 监控的分支（默认：master）
• context - 区分状态的标签（默认：default）
• endpoint - GitHub API端点（默认：https://api.github.com）
• skip_ssl_verification - 禁用证书验证（默认：false）

功能行为

check

当配置上下文的分支状态更新时触发流水线。

in

查询提交状态，输出文件包括：

• /commit：提交引用
• /description：状态描述
• /state：状态（pending/success/error/failure）
• /target_url：关联URL
• /updated_at：更新时间

out

更新提交状态，参数：

• commit - 提交SHA（可来自git目录或文件）
• state - 状态（必须为pending/success/error/failure）
• description - 状态描述
• description_path - 描述文件路径
• target_url - 关联URL（默认：Concourse构建链接）

使用示例

流水线状态标记

在单元测试前后更新提交状态：

yaml
---
jobs:
  - name: "单元测试"
    plan:
      - get: "repo"
        trigger: true
      - put: "repo-status"
        params: { state: "pending", commit: "repo" }
      - task: "单元测试"
        file: "repo/ci/unit-tests/task.yml"
        on_failure:
          - put: "repo-status"
            params: { state: "failure", commit: "repo" }
      - put: "repo-status"
        params: { state: "success", commit: "repo" }
resources:
  - name: "repo"
    type: "git"
    source:
      uri: {{repo_uri}}
      branch: {{repo_branch}}
  - name: "repo-status"
    type: "github-status"
    source:
      repository: {{repo_github_path}}
      access_token: {{repo_github_token}}

拉取请求状态标记

针对PR #***标记状态：

yaml
name: "pr-status"
type: "github-status"
source:
  repository: {{repo_github_path}}
  access_token: {{repo_github_token}}
  branch: "pull/12345/head"

安装方法

全局部署

在所有Concourse worker上安装：

yaml
properties:
  groundcrew:
    additional_resource_types:
      - image: "docker:///dpb587/github-status-resource#master"
        type: "github-status"

特定流水线

在单个流水线中使用：

yaml
resource_types:
  - name: "github-status"
    type: "docker-image"
    source:
      repository: "dpb587/github-status-resource"
      tag: "master"

参考链接

• Concourse资源文档
• https://developer.github.com/v3/repos/statuses/
• https://github.com/settings/tokens

许可证

MIT许可证