为何我的GitHub Actions中black-formatting任务被跳过？

问题根源 #

你碰到的核心问题有两个：

1. GitHub Actions默认会在任务退出码非0时标记任务失败，直接中断后续流程，导致你没法正确捕获并使用退出码作为执行条件
2. 可能错误处理了退出码的捕获逻辑，或者没让失败的任务保留输出结果

正确实现步骤 #

1. 让检查任务即使失败也能输出退出码 #

在check-for-changes任务中必须添加continue-on-error: true，让任务即使退出码非0也能完成执行，同时给步骤加id标记，方便后续读取输出。然后通过$?捕获Black的退出码，用GitHub Actions的新语法写入输出变量。

2. 匹配Black的退出码规则设置条件 #

Black的退出码逻辑是：

• 0：所有文件已格式化，无需修改
• 1：存在需要格式化的文件
  所以格式化任务要在exit_code == '1'时执行。

完整工作流示例 #

name: Python Format Check & Auto-Fix

on: [push, pull_request]

jobs:
  format-handler:
    runs-on: ubuntu-latest
    steps:
      - name: Checkout code
        uses: actions/checkout@v4

      - name: Set up Python
        uses: actions/setup-python@v5
        with:
          python-version: "3.11"

      - name: Install Black
        run: pip install black

      - name: Check formatting status
        id: black-check
        continue-on-error: true
        run: |
          black --check .
          echo "exit_code=$?" >> $GITHUB_OUTPUT

      - name: Run Black formatting
        if: steps.black-check.outputs.exit_code == '1'
        run: black .

      - name: Push formatted changes (可选)
        if: steps.black-check.outputs.exit_code == '1'
        run: |
          git config --global user.name "github-actions[bot]"
          git config --global user.email "github-actions[bot]@users.noreply.github.com"
          git add .
          git commit -m "Auto-format code with Black"
          git push

更优实现方式 #

不需要手动捕获退出码，直接利用步骤的执行结果判断，代码更简洁可靠：

name: Python Format Check & Auto-Fix

on: [push, pull_request]

jobs:
  format-handler:
    runs-on: ubuntu-latest
    steps:
      - name: Checkout code
        uses: actions/checkout@v4

      - name: Set up Python
        uses: actions/setup-python@v5
        with:
          python-version: "3.11"

      - name: Install Black
        run: pip install black

      - name: Run Black check
        id: black-check
        continue-on-error: true
        run: black --check .

      - name: Fix formatting issues
        if: steps.black-check.outcome == 'failure'
        run: black .

      - name: Push auto-formatted changes (可选)
        if: steps.black-check.outcome == 'failure'
        run: |
          git config --global user.name "github-actions[bot]"
          git config --global user.email "github-actions[bot]@users.noreply.github.com"
          git add .
          git commit -m "Auto-format with Black"
          git push

这种方式直接用步骤的outcome（成功/失败）判断，因为Black的--check模式下，需要格式化时任务会失败（对应退出码1），已格式化则成功（对应退出码0），完全契合你的需求。

关键注意事项 #

• 必须给检查步骤加continue-on-error: true，否则任务失败后后续步骤无法执行
• 如果要推送格式化后的代码，要确保GitHub Actions机器人有仓库的推送权限（在仓库设置中允许Actions修改代码）
• 优先使用$GITHUB_OUTPUT设置输出变量，旧的set-output命令已被废弃

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