zarplata/concourse-git-bitbucket-pr-resource

concourse-git-bitbucket-pr-resource

镜像概述和主要用途

concourse-git-bitbucket-pr-resource是Concourse CI的资源类型，用于跟踪Bitbucket拉取请求的所有Git分支变更。该资源设计用于配合Concourse的https://concourse.ci/get-step.html#get-version%E9%85%8D%E7%BD%AE%E4%BD%BF%E7%94%A8%EF%BC%8C%E7%81%B5%E6%84%9F%E6%9D%A5%E6%BA%90%E4%BA%8Ehttps://github.com/vito/git-branch-heads-resource%E9%A1%B9%E7%9B%AE%E3%80%82

核心功能和特性

• 跟踪Bitbucket仓库中所有开放拉取请求的变更
• 支持Bitbucket Server（自托管）和Bitbucket Cloud
• 可配置拉取请求数量限制、路径过滤及变更文件数量限制
• 支持更新拉取请求的构建状态（成功/失败/进行中）
• 支持向拉取请求分支推送提交
• 基于Concourse Git资源实现代码拉取功能

使用场景和适用范围

适用于需要在Concourse CI流水线中：

• 监控Bitbucket拉取请求的创建、更新和关闭
• 针对拉取请求自动触发构建和测试
• 向Bitbucket反馈拉取请求的构建状态
• 自动向拉取请求分支推送代码变更

安装配置

安装

在流水线中添加以下resource_types配置：

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

源配置参数

配置示例

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为分支上的提交。

参数

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

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

out: 更新拉取请求

行为取决于action参数的值：

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

• action: Required，必须为change-build-status
• 除name外的参数遵循https://developer.atlassian.com/server/bitbucket/how-tos/updating-build-status-for-commits/
• name: Deprecated，仅为向后兼容保留
• repository: Optional，用于更改构建状态的源仓库路径

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

• action: Required，必须为push
• repository: Optional，用于推送的源仓库路径

故障排除

问题：标记PR为"构建开始"会创建PR的新版本

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

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