如何在Bitbucket拉取请求中展示流水线生成文件的变更并自动化？

要实现自动生成PR源分支与目标分支的报告差异，同时不将报告文件存入仓库，可以通过以下步骤修改Bitbucket流水线配置：

1. 更新Bitbucket流水线配置 #

修改bitbucket-pipelines.yml，添加拉取目标分支、双分支报告生成及差异对比的逻辑：

image: node:18

definitions:
  steps:
    - step: &generate-report-diff
        name: Generate report diff between branches
        caches:
          - node
        script:
          # 安装当前分支依赖
          - npm install
          # 生成PR源分支的报告并备份
          - npm run scriptThatGeneratesReport
          - cp report.txt report-source.txt
          # 拉取并切换到PR目标分支
          - git fetch origin $BITBUCKET_PR_DESTINATION_BRANCH:$BITBUCKET_PR_DESTINATION_BRANCH
          - git checkout $BITBUCKET_PR_DESTINATION_BRANCH
          # 重新安装目标分支依赖（适配依赖变更场景）
          - npm install
          # 生成目标分支的报告并备份
          - npm run scriptThatGeneratesReport
          - cp report.txt report-target.txt
          # 生成差异文件（即使无差异也保留文件）
          - diff -u report-target.txt report-source.txt > report-diff.txt || true
          # 控制台输出差异内容
          - cat report-diff.txt
        artifacts:
          # 保存报告及差异文件，供评审者在流水线页面下载查看
          - report-source.txt
          - report-target.txt
          - report-diff.txt

pipelines:
  pull-requests:
    "**":
      - step: *generate-report-diff

2. 可选：将差异直接展示在PR评论中 #

如果希望评审者无需进入流水线页面即可查看差异，可以添加PR评论步骤：

1. 在Bitbucket仓库创建具备PR写入权限的API token，添加到流水线环境变量（命名为BITBUCKET_API_TOKEN）
2. 在上述步骤的script末尾追加以下代码：

# 当差异文件非空时，将差异作为PR评论提交
if [ -s report-diff.txt ]; then
  curl -X POST -u "$BITBUCKET_API_TOKEN:" "https://api.bitbucket.org/2.0/repositories/$BITBUCKET_REPO_OWNER/$BITBUCKET_REPO_SLUG/pullrequests/$BITBUCKET_PR_ID/comments" \
    -H "Content-Type: application/json" \
    -d '{
      "content": {
        "raw": "### 报告文件差异（目标分支 → 源分支）\n```diff\n'"$(cat report-diff.txt)"'\n```"
      }
    }'
fi

3. 防止报告文件误提交 #

在项目根目录的.gitignore中添加以下规则：

report.txt
report-source.txt
report-target.txt
report-diff.txt

核心逻辑说明 #

• 流水线自动拉取PR目标分支，分别生成源分支与目标分支的报告文件
• 通过diff命令生成两者的差异文件，同时将所有临时报告文件作为流水线产物保存
• 可选的PR评论步骤会将差异内容直接展示在PR页面，简化评审流程
• 所有临时文件均被加入.gitignore，不会被提交到仓库

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