os33/concourse-pullrequest-resource

os33/concourse-pullrequest-resource 镜像说明

镜像概述

os33/concourse-pullrequest-resource是Concourse CI/CD系统的资源类型，基于GitHub v4 GraphQL API构建，旨在帮助团队将GitHub拉取请求（PR）集成到自动化流水线中，实现PR的状态监控、任务触发与结果反馈，提升代码审查和持续集成效率。

核心功能

• 实时监控GitHub仓库PR的状态变化（创建、更新、合并、关闭等）
• 触发Concourse流水线执行PR相关任务（如代码检查、单元测试、构建验证）
• 获取PR的详细元数据（标题、描述、提交记录、分支信息、关联标签等）
• 将流水线执行结果同步至PR（如添加状态标签、提交评论）

使用场景

• PR自动化验证：当PR创建或更新时，自动运行测试用例，确保代码符合质量标准
• PR状态管理：通过流水线结果标记PR是否通过验证，辅助团队快速决策是否合并
• 多分支PR处理：针对不同目标分支配置差异化的流水线逻辑
• 协作效率提升：减少人工干预，实现PR从提交到合并的全流程自动化

配置说明

在Concourse流水线配置文件（pipeline.yml）中，资源配置需包含以下关键参数：

资源定义示例

yaml
resources:
- name: github-pr-resource
  type: pull-request
  source:
    repository: your-org/your-repo  # GitHub仓库（格式：所有者/仓库名）
    access_token: ((github-access-token))  # GitHub个人访问令牌（需具备repo权限）
    base_branch: main  # 目标分支（可选，默认监听所有分支）
    labels: ["ci-ready"]  # 过滤PR的标签（可选）
    ignore_drafts: true  # 是否忽略草稿PR（可选，默认false）

参数说明

• repository：必填，GitHub仓库的完整路径
• access_token：必填，用于访问GitHub API的令牌
• base_branch：可选，指定监听的目标分支
• labels：可选，仅处理包含指定标签的PR
• ignore_drafts：可选，是否跳过草稿状态的PR

Docker部署示例

该镜像主要作为Concourse资源类型使用，由Concourse自动拉取和管理。若需本地调试，可使用以下命令执行资源的check操作：

bash
docker run --rm \
  -e GITHUB_TOKEN=your-github-token \
  os33/concourse-pullrequest-resource check \
  '{"source": {"repository": "your-org/your-repo", "base_branch": "main"}}'

注意：本地调试时需替换your-github-token、your-org和your-repo为实际值。