djirik/github-pr-resource

GitHub PR资源镜像（支持子模块克隆）

![Build Status]([***]
https://goreportcard.com/badge/github.com/telia-oss/github-pr-resource](https://goreportcard.com/report/github.com/telia-oss/github-pr-resource)

这是telia-oss/github-pr-resource的分叉版本，新增子模块克隆支持，是用于GitHub拉取请求（PR）的Concourse资源，基于Go语言开发并使用GitHub V4（GraphQL）API。灵感来源于https://github.com/jtarchie/github-pullrequest-resource，核心差异包括：

• GitHub V4 API：check操作每100个开放PR仅需1次API调用（详见#成本）。
• 拉取/合并：get操作将PR指定提交合并到最新基础分支，确保测试准确性。
• 元数据：get/put提供PR及基础分支的提交SHA信息。
• Webhook：无需缓存，与Webhook兼容。

源配置

注意：v3_endpoint与v4_endpoint需同时设置；Webhook配置参考Concourse文档。

核心功能

1. PR检查：按提交日期生成新版本，支持Webhook触发。
2. 代码拉取与合并：克隆基础分支并合并PR提交，提供元数据（如提交SHA）。
3. 状态与评论管理：设置PR状态（成功/失败）、添加评论或删除旧评论。
4. 子模块支持：分叉版本新增子模块克隆功能。

使用场景

• Concourse流水线中自动化处理GitHub PR（如测试、构建验证）。
• 对PR进行状态跟踪与评论反馈。
• 处理包含子模块的仓库PR。

操作示例

Docker Run（简化示例）

bash
docker run --rm djirik/github-pr-resource check \
  -source '{"repository":"itsdalmo/test-repository","access_token":"YOUR_TOKEN"}'

Concourse流水线示例

yaml
resource_types:
- name: pull-request
  type: docker-image
  source: {repository: djirik/github-pr-resource}

resources:
- name: pull-request
  type: pull-request
  check_every: 24h
  webhook_token: ((webhook-token))
  source:
    repository: your-org/your-repo
    access_token: ((github-token))

jobs:
- name: test-pr
  plan:
  - get: pull-request
    trigger: true
  - put: pull-request
    params: {path: pull-request, status: pending}
  - task: run-tests
    config:
      platform: linux
      image_resource: {type: docker-image, source: {repository: golang, tag: 1.21}}
      inputs: [{name: pull-request}]
      run:
        path: sh
        args: ["-c", "cd pull-request && go test ./..."]
    on_failure:
      put: pull-request
      params: {path: pull-request, status: failure}
  - put: pull-request
    params: {path: pull-request, status: success}

成本

GitHub API速率限制为每小时5000次请求：

• check：按PR数量计算（如1000个PR成本约20）。
• get：固定成本1。
• put：基础成本1，每增加状态/评论操作加1。

迁移说明

若从原始资源迁移，需注意参数变化（如repo→repository、ci_skip→disable_ci_skip），详情参考https://github.com/telia-oss/github-pr-resource#migrating%E3%80%82