boringdownload/jira-integration

Jira Development Integration

镜像概述和主要用途

该镜像用于将CI/CD流水线的构建和部署信息集成到Jira开发面板，支持各类CI/CD平台（如Drone、Gitlab CI、Cloud Run等）。仅适用于Jira Cloud，不支持Jira Server（自托管版）。

核心功能和特性

• 同步CI/CD构建和部署状态至Jira开发面板
• 兼容所有支持运行Docker镜像的CI/CD平台
• 通过环境变量灵活配置，支持自定义构建名称和状态
• 自动从分支名解析Jira Issue（如未手动指定）
• 支持构建（build）和部署（deployment）两种事件类型

使用场景和适用范围

适用于使用Jira Cloud进行项目管理的开发团队，需将CI/CD流水线状态（构建成功/失败、部署信息）直接展示在Jira开发面板中，实现开发流程与项目管理的无缝集成。

先决条件

生成OAuth凭证

需在Jira Cloud中生成OAuth凭证，具体步骤参考Atlassian官方文档：[***]

使用方法和配置说明

Docker镜像来源

提供以下镜像源，可根据需求选择：

• Docker Hub: boringdownload/jira-integration
• Github Container Registry: ghcr.io/rohit-gohri/jira-ci-cd-integration
• Gitlab Container Registry: registry.gitlab.com/rohit-gohri/jira-ci-cd-integration

环境变量配置

通过环境变量进行配置，详细参数说明见选项。

不同CI/CD平台配置示例

Drone.io

1. 添加JIRA_CLIENT_ID和JIRA_CLIENT_SECRET作为secret
2. 在流水线配置中添加以下步骤：

yaml
steps:
  - name: jira-integration
    image: boringdownload/jira-integration:v0
    environment:
      BUILD_NAME: drone-pipeline
      JIRA_INSTANCE: companyname
      JIRA_CLIENT_ID:
        from_secret: jira_client_id
      JIRA_CLIENT_SECRET:
        from_secret: jira_client_secret

Gitlab CI/CD

1. 添加JIRA_CLIENT_ID和JIRA_CLIENT_SECRET作为CI/CD变量（建议标记为"Masked"）
2. 在.gitlab-ci.yml中添加以下步骤（使用.post阶段确保最后执行）：

yaml
jira-integration-on-success:
  stage: .post
  when: on_success
  image: registry.gitlab.com/rohit-gohri/jira-ci-cd-integration:v0
  script: jira-integration
  variables:
    BUILD_STATE: successful
    BUILD_NAME: gitlab-pipeline
    JIRA_INSTANCE: companyname

jira-integration-on-failure:
  extends: jira-integration-on-success
  when: on_failure
  variables:
    BUILD_STATE: failure

选项

输入参数（环境变量）

jira_instance (JIRA_INSTANCE) - 必填

Jira Cloud实例的子域名，即URL中的<jira_instance>部分：https://<jira_instance>.atlassian.net

client_id (JIRA_CLIENT_ID) - 必填

OAuth凭证的Client ID

client_secret (JIRA_CLIENT_SECRET) - 必填

OAuth凭证的Client Secret

event_type (JIRA_EVENT_TYPE) - 可选

事件类型，可选值："build"（构建）或"deployment"（部署），默认值："build"

state (BUILD_STATE) - 可选

构建/部署状态，可选值："successful"/"success"（成功）、"failed"（失败）、"canceled"（取消），默认值："unknown"

issue (JIRA_ISSUES) - 可选

Jira Issue编号，如未提供，将自动从分支名解析。支持多个Issue。

token - 可选（仅Github Action）

Github Token，用于在Pull Request事件中获取提交消息（通过SHA从Github API获取）

流水线信息

Commit Message (COMMIT_MESSAGE)

如提交消息中包含Jira Issue ID，可提供此变量

Pipeline Name (BUILD_NAME)

流水线名称，用于在Jira中标识构建/部署任务