如何在Merge Request中对原文件与修改文件运行自定义对比脚本

我正在为LabVIEW项目创建CI脚本，现有一个对比脚本，需要传入两个参数（old-file、new-file），可可视化展示两个文件的差异，且要求两个文件名必须不同。我希望在Merge Request（MR）中使用该脚本，需要获取MR中的修改文件列表，并为每个修改文件传入新旧文件对。

我已有如下初始流水线，其中的伪代码部分需要完善：

workflow:
  rules:
    - if: $CI_PIPELINE_SOURCE == 'merge_request_event'

MassCompile:
  stage: MassCompile
  tags:
    - labview,linux
  script:
    - echo "Executing MassCompile stage"
    - echo $CI_PROJECT_DIR
    - echo $CI_BUILDS_DIR
    - xvfb-run -a LabVIEWCLI -LabVIEWPath "/usr/local/natinst/LabVIEW-2023-64/labview" -OperationName MassCompile -DirectoryToCompile $CI_PROJECT_DIR

Diff:
  stage: Diff
  tags:
    - labview,linux
  script:
    - echo "Executing Diff stage"
    - git fetch
    - git diff --name-only origin/$CI_MERGE_REQUEST_SOURCE_BRANCH_NAME origin/$CI_MERGE_REQUEST_TARGET_BRANCH_NAME | grep '\.vi$'
    - <pseudo-code>:
      -- for each file-in-the-list-above as changedFile
      {
        - old-file = get changedFile from the target branch
        - rename old-file: changedFile-old
        - call compare-script(changedFile, changedFile-old)
      }

stages:
  - MassCompile
  - Diff

需要实现的功能：

• 为每个已更新的文件获取目标分支上的原文件
• 重命名该原文件
• 传入MR中的文件与重命名后的原文件调用对比脚本

请问实现该需求的最佳方式是什么？是否需要检出目标分支并定位相关文件？是否有git命令可获取MR中各文件的前后版本？

核心思路 #

不需要完整检出目标分支，利用git show命令直接提取目标分支上的文件内容到指定名称的文件即可，既高效又避免分支切换的麻烦。

完善后的Diff阶段脚本 #

将伪代码替换为以下Shell脚本逻辑：

Diff:
  stage: Diff
  tags:
    - labview,linux
  script:
    - echo "Executing Diff stage"
    # 拉取目标分支的最新内容
    - git fetch origin $CI_MERGE_REQUEST_TARGET_BRANCH_NAME
    # 获取所有修改的VI文件列表
    - git diff --name-only origin/$CI_MERGE_REQUEST_TARGET_BRANCH_NAME origin/$CI_MERGE_REQUEST_SOURCE_BRANCH_NAME | grep '\.vi$' | while read FILE; do
        # 从目标分支提取旧版本文件，命名为原文件名-old
        git show origin/$CI_MERGE_REQUEST_TARGET_BRANCH_NAME:"$FILE" > "$FILE-old"
        # 确保对比脚本有执行权限
        - chmod +x compare-script
        # 调用对比脚本，传入新版本文件和旧版本文件
        ./compare-script "$FILE" "$FILE-old"
      done

关键说明 #

1. 无需完整检出目标分支：通过git fetch拉取目标分支的最新快照，再用git show <分支>:<文件路径>直接提取指定文件的内容到本地文件，不需要切换分支或完整检出。
2. 文件名处理：将旧版本文件命名为原文件名-old，满足对比脚本对不同文件名的要求。
3. git命令的作用：
   • git fetch origin <目标分支>：确保本地拥有目标分支的最新内容
   • git diff --name-only <目标分支> <源分支>：获取两个分支间差异的文件列表
   • git show <分支>:<文件路径>：直接输出指定分支下指定文件的内容，重定向到本地文件即可得到旧版本文件

注意事项 #

• 若文件路径包含空格，必须用while read循环替代for循环，避免路径被错误拆分
• 提前给compare-script添加可执行权限，确保脚本能正常运行

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