sovanyio/concourse-git-bitbucket-pr-resource

concourse-git-bitbucket-pr-resource

跟踪所有Git分支的拉取请求变更。

此资源需配合 https://concourse.ci/get-step.html#get-version 使用。

灵感来源于 https://github.com/vito/git-branch-heads-resource

镜像概述和主要用途

该镜像用于在Concourse CI中跟踪BitBucket仓库的拉取请求变更，支持BitBucket Cloud和自托管BitBucket Server，可检测拉取请求的新建、更新或移除，并触发CI/CD流程，同时支持更新拉取请求的构建状态和推送提交。

核心功能和特性

• 跟踪指定BitBucket仓库的所有拉取请求变更
• 支持BitBucket Cloud和自托管BitBucket Server
• 可配置路径过滤，仅跟踪特定文件变更
• 集成Git资源功能，获取拉取请求的提交内容
• 支持更新拉取请求的构建状态（成功/失败/进行中）
• 支持推送提交到拉取请求分支

安装

在pipeline中添加以下resource_types配置：

yaml
---
resource_types:
- name: git-bitbucket-pr
  type: docker-image
  source:
    repository: zarplata/concourse-git-bitbucket-pr-resource

源配置（Source Configuration）

• base_url: 必填。BitBucket服务器的基础URL，不带末尾斜杠。例如：http://bitbucket.local
• project: 必填。跟踪的项目名称
• repository: 必填。跟踪的仓库名称
• limit: 可选。跟踪的拉取请求数量限制，默认值：100
• git: 必填。基于https://github.com/concourse/git-resource%E7%9A%84%E9%85%8D%E7%BD%AE%EF%BC%8C%E5%8E%9FGit%E8%B5%84%E6%BA%90%E4%B8%AD%E7%9A%84%60branch%60%E9%85%8D%E7%BD%AE%E4%BC%9A%E8%A2%AB%E5%BF%BD%E7%95%A5
• bitbucket_type: 可选。cloud表示BitBucket Cloud，server表示自托管BitBucket Server，默认值：server
• dir: 已弃用。若资源名称与仓库名称不同，可设置为资源名称。已被out动作中的params.repository替代
• branch: 可选。若指定，仅检查针对该分支的拉取请求
• paths: 可选。若指定（作为glob模式列表），仅当指定文件变更时才会生成新版本
• changes_limit: 可选。每个拉取请求加载的最大变更路径数量，默认值：100。仅与paths参数配合使用
• direction: 可选。相对于指定仓库的方向，incoming（目标分支，如合并到master）或outgoing（源分支，如从feature分支）

认证方式（二选一）：

• username: 必填。具有仓库访问权限的用户名
• password: 必填。该用户的密码

或

• oauth_id: 必填。配置为私有且具有PR写入权限的OAuth消费者ID
• oauth_secret: 必填。同一OAuth消费者的密钥

配置示例

yaml
resources:
- name: my-repo-with-pull-requests
  type: git-bitbucket-pr
  source:
    base_url: http://bitbucket.local
    username: some-username
    password: some-password
    project: zarplata
    repository: concourse-git-bitbucket-pr-resource
    git:
      uri: https://github.com/zarplata/concourse-git-bitbucket-pr-resource
      private_key: {{git-repo-key}}

jobs:
  - name: my build
    plan:    
      - get: my-repo-with-pull-requests
        trigger: true
        version: every
      - task: unit test
          ...
          inputs:          
            - name: my-repo-with-pull-requests
          run:
          ...
        on_failure:
          put: my-repo-with-pull-requests
          params:
            action: change-build-status
            state: FAILED
            name: "unit test"
            url: "http://acme.com/teams/$BUILD_TEAM_NAME/pipelines/$BUILD_PIPELINE_NAME/jobs/$BUILD_JOB_NAME/builds/$BUILD_NAME"
        on_success:
          put: my-repo-with-pull-requests
          params:
            action: change-build-status
            state: SUCCESSFUL
            name: "unit test"
            url: "http://acme.com/teams/$BUILD_TEAM_NAME/pipelines/$BUILD_PIPELINE_NAME/jobs/$BUILD_JOB_NAME/builds/$BUILD_NAME"

行为

check: 检查所有拉取请求的变更

从BitBucket服务器获取指定项目和仓库的当前开放拉取请求，将更新时间与上次获取的拉取请求进行比较。若有拉取请求新建、更新或移除，会生成新版本。

in: 获取拉取请求变更的提交

该资源完全委托给原始Git资源的in动作，将source.git传递给原始git-resource的source，并指定source.branch为变更分支，version.ref为分支上的提交。

参数

除以下参数外，所有params将传递给原始git-resource的params：

• skip_download: 可选。跳过git pull，基于Git的工件将不存在
• fetch_upstream: 可选。同时获取拉取请求的上游引用，这将覆盖fetch参数

out: 更新拉取请求

行为取决于action参数的值：

• change-build-status: 更改提交构建状态

  • action: 必填。此行为需设为change-build-status
  • 除name外的参数遵循https://developer.atlassian.com/server/bitbucket/how-tos/updating-build-status-for-commits/
  • name: 已弃用。仅为向后兼容保留
  • repository: 可选。用于更改构建状态的源仓库路径

• push: 推送提交到拉取请求分支

  • action: 必填。此行为需设为push
  • repository: 可选。用于推送的源仓库路径

故障排除

• https://github.com/zarplata/concourse-git-bitbucket-pr-resource/issues/15

  Concourse无法跳过版本，但有解决方法：添加一个与pull-request设置相同的资源，仅用于更改构建状态。

  yaml
  - name: test-pull-requests
    plan:
    - get: pull-request
      trigger: true
      version: every
    - get: node
    - put: pull-request-status
      params:
        action: change-build-status
        state: INPROGRESS
        key: concourse-build
        description: Building on Concourse