如何配置Bitbucket Pipeline在PR合并至master前自动运行Black格式化代码？

问题分析 #

你当前的配置是在代码已经推送到master分支后才运行Black，这就导致格式化操作晚于提交。要实现「合并前先格式化再完成提交」的效果，需要调整触发时机，或者在master分支的Pipeline里完成格式化后自动提交代码。

方案一：在PR阶段触发格式化（推荐） #

把Pipeline的触发时机改成PR的预合并检查阶段，这样在PR合并前就会自动格式化代码，还可以选择将格式化后的代码推回PR分支。配置如下：

image: python:3.10

pipelines:
  pull-requests:
    '**':
      - step:
          name: 用Black格式化代码
          script:
            - pip install black
            - black -l 88 .
          # 可选：自动将格式化后的代码推回PR分支
          after-script:
            - git config user.name "Bitbucket Pipeline"
            - git config user.email "pipeline@bitbucket.org"
            - git add .
            - git commit -m "Auto-format code with Black" || echo "No changes to commit"
            - git push origin $BITBUCKET_PR_SOURCE_BRANCH

方案二：在master分支推送后自动提交格式化代码 #

如果坚持要在master分支上处理，需要在运行Black后，将格式化后的代码推回master。注意配置权限并避免Pipeline循环触发：

image: python:3.10

pipelines:
  branches:
    master:
      - step:
          name: 运行Black并提交格式化代码
          script:
            - pip install black
            - black -l 88 .
            # 配置Git用户信息
            - git config user.name "Bitbucket Pipeline"
            - git config user.email "pipeline@bitbucket.org"
            # 提交格式化后的代码，无变更时跳过
            - git add .
            - git commit -m "Auto-format code with Black [skip ci]" || echo "没有需要提交的格式化变更"
            # 推回master分支
            - git push origin master
          # 需要完整克隆仓库以支持提交
          clone:
            depth: full

关键注意事项 #

• 要让Pipeline能推送代码，需在Bitbucket仓库的「设置」→「Pipeline设置」中开启「允许Pipeline修改仓库」的权限。
• 提交信息里的[skip ci]可以避免格式化提交再次触发Pipeline，防止循环执行。
• 方案一更符合PR工作流，能在合并前完成代码格式化，避免master分支产生额外的自动提交记录。

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