误合并部署分支配置后，如何在GitLab合并请求中排除指定文件？

问题描述 #

误将部署分支deploymentdev的代码拉取到主开发分支main并推送，导致部署专属配置文件Jenkinsfile、.gitlab-ci.yml、Dockerfile进入main分支。现在从main向其他部署分支（如deploymentstage）创建合并请求时，这些文件会被包含在变更中，引发以下问题：

• 每个部署分支（dev/stage/test/prod）都有各自专属版本的这些文件；
• 这些文件绝对不能在部署分支之间合并。

已尝试方案 #

• 将文件加入.gitignore并执行git rm --cached Jenkinsfile .gitlab-ci.yml Dockerfile，但DevOps团队表示这会破坏CI/CD流水线；
• 使用git update-index --skip-worktree Jenkinsfile .gitlab-ci.yml Dockerfile，但该操作仅影响本地仓库，且变更已提交，合并请求中仍会显示这些文件；
• 考虑过git reset --hard <commit_id>，但问题提交时间跨度从一年前到两周前，操作不现实；
• 尝试在deploymentstage中手动修复并排除这些文件，但触发了CI/CD流水线，这是需要避免的情况。

关键背景 #

• 这些配置文件未被加入.gitignore，因为DevOps团队需要追踪其变更；
• 部署分支数量众多，手动编辑所有分支不可行；
• 每次向部署分支创建合并请求时，DevOps团队都需要在该实例首次运行CI/CD流水线时手动替换这些文件。

核心问题 #

如何在不删除仓库历史记录、不破坏现有DevOps工作流的前提下，在GitLab合并请求中排除指定文件Jenkinsfile、.gitlab-ci.yml、Dockerfile？

解决方案 #

方法1：GitLab合并请求内置文件排除（推荐） #

GitLab原生支持在合并请求中设置文件排除规则，步骤如下：

1. 打开目标合并请求页面，点击右侧「Settings」（设置）选项卡；
2. 在「Merge request settings」下找到「Exclude files」输入框；
3. 逐行输入需要排除的文件路径：

   Jenkinsfile
   .gitlab-ci.yml
   Dockerfile
   

4. 保存后，合并请求将不再显示这些文件的变更，合并时也不会同步这些文件的修改到目标分支。

方法2：创建临时分支剔除配置文件差异 #

如果需要更灵活的控制，可以通过临时分支处理：

1. 基于main创建临时分支：

   git checkout main
   git pull origin main
   git checkout -b main-no-deploy-configs
   

2. 从目标部署分支拉取对应配置文件覆盖当前分支：

   git checkout deploymentstage -- Jenkinsfile .gitlab-ci.yml Dockerfile
   

3. 提交覆盖修改并推送：

   git add Jenkinsfile .gitlab-ci.yml Dockerfile
   git commit -m "Revert deploy configs to deploymentstage version"
   git push origin main-no-deploy-configs
   

4. 基于这个临时分支向deploymentstage创建合并请求，此时配置文件已和目标分支版本一致，不会出现在变更列表中。

方法3：CI/CD配置跳过特定文件触发 #

如果无法避免合并请求中出现这些文件，可以让DevOps团队修改CI/CD规则，仅当这些文件变更时跳过流水线：
在.gitlab-ci.yml中添加规则：

workflow:
  rules:
    - if: '$CI_PIPELINE_SOURCE == "merge_request_event"'
      changes:
        - Jenkinsfile
        - .gitlab-ci.yml
        - Dockerfile
      when: never
    - when: always

这样当合并请求中只有这三个文件的变更时，不会触发流水线。

方法4：长期方案：Git合并规则配置 #

从根源解决问题，配置Git合并驱动，让合并时自动保留目标分支的配置文件版本：

1. 在仓库根目录创建.gitattributes文件，添加：

   Jenkinsfile merge=ours
   .gitlab-ci.yml merge=ours
   Dockerfile merge=ours
   

   merge=ours表示合并时始终保留当前分支（目标部署分支）的文件版本，忽略来源分支的修改。
2. 提交并推送该文件到所有分支：

   git add .gitattributes
   git commit -m "Add merge rules for deploy config files"
   git push origin main
   

   后续合并时Git会自动处理这些文件，无需手动干预。

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