如何通过API同步GitHub Release Notes至对应JIRA版本发布说明

完全支持通过JIRA API编辑版本发布说明，可实现GitHub Release Notes与JIRA版本发布说明的自动同步。

核心实现依据 #

JIRA全版本（Cloud/Server/Data Center）均开放了版本资源的操作接口，JIRA中每个版本的「发布说明」内容实际存储在版本实体的description字段中，可直接通过更新接口修改该字段内容。

落地步骤 #

• 提前维护版本映射关系：配置GitHub Release标签（tag）与JIRA项目内对应版本的唯一ID/版本名的映射规则，避免内容同步到错误版本。
• 拉取源内容：获取GitHub指定版本的Release Notes原文，按需做格式适配：GitHub默认使用标准Markdown语法，JIRA原生使用Atlassian Wiki标记，若未开启JIRA端Markdown渲染能力，需要先做格式转换，避免排版错乱。
• 调用JIRA更新接口：
  接口请求示例（以JIRA Cloud v3版本API为例）：

  PUT /rest/api/3/version/{versionId}
  请求体：
  {
    "description": "格式转换后的发布说明正文内容"
  }
  

  请求头需要携带合法的身份认证信息：Cloud版本使用邮箱+API Token做基础认证，Server/Data Center版本可使用个人访问令牌（PAT）认证，注意调用账号需要持有对应项目的版本编辑权限，否则会返回403权限报错。
• 结果校验：同步请求发送后，可调用版本查询接口拉取对应版本的description字段做内容比对，确认同步成功，失败场景可配置重试逻辑。

效率优化建议 #

可以直接配置GitHub Action工作流，监听GitHub的release published事件，当有新版本正式发布时自动触发全流程同步，无需人工介入。

内容的提问来源于stack exchange，提问作者Venkataraman