chrised/github-status-resource

github-status-resource

这是一个http://concourse.ci/资源，用于与https://developer.github.com/v3/repos/statuses/类型交互。

镜像概述

该镜像作为Concourse的扩展资源，实现了与GitHub Status API的对接，允许用户在Concourse流水线中查询或更新GitHub代码仓库中提交的状态信息，助力流水线流程的状态跟踪与可视化。

核心功能

• check：当配置上下文下分支的状态更新时触发。
• in：查询状态信息，输出包含提交引用、描述、状态、目标URL及更新时间等内容。
• out：更新提交的状态，可指定状态（pending/success/error/failure）、描述及目标URL。

使用场景

• 流水线中单元测试前后更新提交状态（如测试开始时设为pending，结束后设为success或failure）。
• 跟踪Pull Request（PR）的状态，为PR设置特定分支的状态检查。

配置说明

资源源配置（source）

• 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：是否禁用GitHub API调用的证书验证（默认：false）。

out参数

• commit：必填，提交SHA值（可指定git目录路径或包含SHA的文件路径）。
• 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" }  # 测试开始时设为pending
      - task: "单元测试"
        file: "repo/ci/unit-tests/task.yml"
        on_failure:
          - put: "repo-status"
            params: { state: "failure", commit: "repo" }  # 测试失败设为failure
      - put: "repo-status"
        params: { state: "success", commit: "repo" }  # 测试成功设为success
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
resources:  
  - name: "pr-status"  
    type: "github-status"  
    source:  
      repository: {{repo_github_path}}  
      access_token: {{repo_github_token}}  
      branch: "pull/12345/head"  # PR #12345的分支

安装方法

全局部署（所有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"

参考链接

• https://concourse.ci/resources.html
• https://developer.github.com/v3/repos/statuses/
• https://help.github.com/articles/enabling-required-status-checks/
• https://github.com/settings/tokens

许可证

MIT许可证