b1lorenzen/telia-oss_github-pr-resource

GitHub PR资源

![Build Status]([] ![Go Report Card]([]

镜像概述

这是一个Concourse资源，用于处理GitHub上的拉取请求（PR），采用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良好配合。

核心功能

1. 检查（check）：生成PR的新版本（按提交日期排序），版本包含PR编号、提交SHA和提交时间戳。
2. 获取（get）：克隆基础分支最新提交，合并PR指定提交；支持merge/rebase/checkout三种集成方式；可生成变更文件列表；自动解密git-crypt加密仓库。
3. 推送（put）：设置PR提交状态（SUCCESS/PENDING/FAILURE/ERROR）；添加评论或从文件读取评论；指定状态上下文与目标URL；删除旧评论。

使用场景

• CI/CD流水线中自动触发PR测试。
• 实时更新PR状态，通知开发者测试结果。
• 针对PR中的特定文件变更执行任务。
• 处理来自fork仓库的PR（需配置check_every定期检查）。

配置说明

源配置（Source Configuration）

Get参数

Put参数

部署示例

yaml
resource_types:
- name: pull-request
  type: docker-image
  source:
    repository: teliaoss/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