justvanilla/github-pr-resource

镜像概述

justvanilla/github-pr-resource是Concourse CI的资源类型，用于管理GitHub拉取请求（PR）。它基于GitHub V4 GraphQL API开发，相比传统REST API资源更高效，支持PR状态更新、合并验证、元数据获取等功能，助力CI/CD流程自动化。

核心功能

1. 高效API调用：check操作每100个开放PR仅需1次GraphQL API请求，减少API消耗。
2. 精准合并：get操作将PR特定提交合并到最新基础分支，确保测试基于准确版本。
3. 元数据支持：提供PR和基础分支的提交SHA等元数据，便于任务使用。
4. Webhook兼容：无缓存设计，无缝集成GitHub的push/pull_request事件Webhook。
5. 灵活过滤：通过文件路径、标签、分支等条件筛选PR，仅处理符合要求的内容。
6. 状态与评论：支持设置PR状态（成功/失败/待处理）及添加评论。

使用场景

• PR自动化测试：PR提交时自动触发单元测试、代码检查，并更新PR状态。
• PR合并验证：要求PR满足批准数量等条件后才触发CI流程。
• PR评论自动化：自动添加构建结果或分析报告到PR评论区。
• 文件变更过滤：仅修改特定路径（如Terraform文件）时触发对应CI任务。

配置说明

源配置参数

行为说明

• check：生成PR新版本（按提交时间排序），支持Webhook触发。
• get：克隆基础分支并合并PR提交，支持浅克隆、子模块递归克隆等参数。
• put：更新PR状态或添加评论，支持从文件读取评论内容、删除历史评论等功能。

部署示例（Concourse配置）

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

resources:
- name: pull-request
  type: pull-request
  check_every: 24h
  webhook_token: ((webhook-token))
  source:
    repository: itsdalmo/test-repository
    access_token: ((github-access-token))

jobs:
- name: test
  plan:
  - get: pull-request
    trigger: true
    version: every
  - put: pull-request
    params: {path: pull-request, status: pending}
  - task: unit-test
    config:
      platform: linux
      image_resource: {type: docker-image, source: {repository: alpine/git, tag: latest}}
      inputs: [{name: pull-request}]
      run:
        path: /bin/sh
        args: [-xce, "cd pull-request && git log --graph --all --color --pretty=format:\"%x1b[31m%h%x09%x1b[32m%d%x1b[0m%x20%s\" > log.txt && cat log.txt"]
    on_failure:
      put: pull-request
      params: {path: pull-request, status: failure}
  - put: pull-request
    params: {path: pull-request, status: success}