如何强迫工作退出github行动步骤

Question

如果满足特定条件，我想退出工作：

jobs:
  foo:
    steps:
      ...
      - name: Early exit
        run: exit_with_success # I want to know what command I should write here
        if: true
      - run: foo
      - run: ...
 ...

我该怎么做？

Answer 1

当前没有办法任意退出工作，但是如果较早的步骤失败，则有一种方法可以使用条件：

jobs:
  foo:
    steps:
      ...
      - name: Early exit
        run: exit_with_success # I want to know what command I should write here
      - if: failure()
        run: foo
      - if: failure()
        run: ...
 ...

想法是，如果第一步失败，则其余部分将运行，但是如果第一步不会失败，则其余部分将不会运行。

但是，需要注意的是，如果任何后续步骤都会失败，那么它们之后的步骤仍将运行，这可能是理想的，也可能不是可取的。

---

另一个选项是使用“ noreferrer”>步骤输出表明失败或成功：

jobs:
  foo:
    steps:
      ...
      - id: s1
        name: Early exit
        run: # exit_with_success
      - id: s2
        if: steps.s1.conclusion == 'failure'
        run: foo
      - id: s3
        if: steps.s2.conclusion == 'success'
        run: ...
 ...

此方法效果很好，并为您提供了允许哪些步骤运行的非常细粒度的控制，但是何时，它在所有需要的条件下变得非常冗长。

---

另一个选择是要有两个作业：

• 一个检查您的病情
• 另一个取决于它的工作：

jobs:
  check:
    outputs:
      status: ${{ steps.early.conclusion }}
    steps:
      - id: early
        name: Early exit
        run: # exit_with_success
  work:
    needs: check
    if: needs.check.outputs.status == 'success'
    steps:
      - run: foo
      - run: ...
 ...

最后一个方法通过将支票移入单独的作业并让另一个工作等待并检查状态来很好地奏效。但是，如果您有更多的工作，则必须在每个工作中重复相同的检查。与每个步骤进行检查相比，这还不错。

---

注意： 在最后一个示例中，您可以使用 object filter 语法，然后使用该语法 包含 在进一步的工作中发挥作用，以确保没有任何步骤失败：

jobs:
  check:
    outputs:
      status: ${{ join(steps.*.conclusion) }}
    steps:
      - id: early
        name: Early exit
        run: # exit_with_success
      - id: more_steps
        name: Mooorreee
        run: # exit_maybe_with_success
  work:
    needs: check
    if: !contains(needs.check.outputs.status, 'failure')
    steps:
      - run: foo
      - run: ...

此外，请记住，“失败”和“成功”并不是一个步骤中唯一的结论。参见 steass出于其他可能的原因，。

Answer 2

exit可以使用GH Run Cance和GH Run观看命令：

- name: Early exit
  run: |
    gh run cancel ${{ github.run_id }}
    gh run watch ${{ github.run_id }}
  env:
    GH_TOKEN: ${{ secrets. GITHUB_TOKEN }}

观看是必需的，因为取消是必需的不会立即流产。

您可能需要操作：'Write'为作业添加了权限，类似：

permissions:
  ...
  actions: 'write'

Answer 3

如果其他发布的答案无法解决您的问题，那么您可以考虑创建一个确定应该运行哪些作业并跳过哪些作业的作业。
该解决方案利用作业输出 。<<<<<<<<<<<<<<<< br>
这是一个示例：

jobs:
  planner:
    name: Determine which jobs to run
    runs-on: ubuntu-latest
    # To keep it simple name the step and output the same as job
    outputs:
      foo: ${{ steps.foo.outputs.should-run }}

    steps:
      # Checkout if necessary to determine whether 'foo' needs to run
      # - uses: actions/checkout@v4

      - name: Mark foo job as 'to be run'
        id: foo
        # Replace 'true' with your condition
        run: echo "should-run=true" >> $GITHUB_OUTPUT

  foo:
    runs-on: ubuntu-latest
    needs: planner
    # Skip this job when condition not met
    if: needs.planner.outputs.foo == 'true'

    steps:
      - uses: actions/checkout@v4
      # ...

该方法的一个例子是，当您拥有昂贵的工作时，如果输出相同，则可以跳过。例如，针对最新标签进行夜间测试，但最新标签尚未更改。

Answer 4

我只是通过运行退出1来做到这一点，

job:
  runs-on: ubuntu-latest
    steps:
      - name: 'Stage 1'
        run: |
          if [[ "${{ github.event.head_commit.message }}" =~ \[run-stage-2\] ]];
          then
            echo "Valid commit message detected. stage 2 will run."
          else 
            echo "Valid commit message not detected. stage 2 will not run."
            exit 1
          fi
      - name: 'Stage 2'
        run: <whatever>

因此，在这里，阶段1一个检查提交消息是否包含[Run stage-2]。如果这样做，阶段1将完成，第2阶段将开始；但是如果没有，退出1被调用，工作流将失败。