Airflow 取消工作流运行指南

Airflow 取消工作流运行指南

airflow-cancel-workflow-runsFork of potiukcancel-workflow-runs action 项目地址:https://gitcode.com/gh_mirrors/ai/airflow-cancel-workflow-runs

---

项目介绍

Apache Airflow 的一个衍生插件——airflow-cancel-workflow-runs，旨在提供一种自动化机制来取消指定条件下的工作流运行。这尤其适用于那些希望优化资源利用、避免重复执行或当有特定事件（如Pull Request合并、失败作业）触发时自动管理GitHub Actions工作流场景。通过灵活配置，它可以作用于特定的工作流、基于事件类型以及自定义模式，实现对工作流程的有效控制。

---

项目快速启动

要开始使用 airflow-cancel-workflow-runs，首先确保你有一个运行着GitHub Actions的项目，并且已经熟悉基本的.github/workflows配置。

步骤一：添加依赖

在你的项目中，确保你的GitHub Actions工作流能够访问到这个action。虽然直接在Apache的仓库里查找该Action，但这里我们假设一个典型的用法：

1. 在.github/workflows目录下创建一个新的YAML文件，比如cancel-workflow.yml。

2. 引入potiuk/cancel-workflow-runs@master这个Action。以下是一个简单的示例，展示了如何设置以取消自我循环的工作流运行：

   name: "Cancel Self-Cancelling Workflow"
   on:
     workflow_run:
       workflows: ['YourTriggerWorkflow']
       types: ['requested']
   jobs:
     cancel-workflow:
       runs-on: ubuntu-latest
       steps:
         - name: "Cancel workflow run"
           uses: potiuk/cancel-workflow-runs@master
           with:
             cancelMode: self
             token: ${{ secrets.GITHUB_TOKEN }}
             notifyPRCancel: true
   

步骤二：配置参数

• cancelMode: 指定取消模式，如self表示取消自身工作流运行。
• token: 使用GitHub Secrets中的GITHUB_TOKEN，保证Action有权限操作工作流。
• notifyPRCancel: 若设为true，将在取消由Pull Request触发的工作流后，在关联的PR中添加评论说明原因。

---

应用案例和最佳实践

案例一：故障快速响应

当你想要任何由Failed Jobs触发的工作流立即终止其他相关联的运行，可以这样配置：

name: "Cancel on Failed Jobs"
on:
  workflow_run:
    workflows: ['MonitorJobs']
    types: ['completed']
jobs:
  cancel-failed-jobs:
    runs-on: ubuntu-latest
    steps:
      - name: "Cancel on Failed Jobs"
        uses: potiuk/cancel-workflow-runs@master
        with:
          cancelMode: namedJobs
          token: ${{ secrets.GITHUB_TOKEN }}
          jobNameRegexps: ${{ steps.detect-failed-jobs.outputs.jobNames }}

最佳实践：

• 确保细粒度地控制哪些工作流会被影响，防止误操作。
• 利用条件语句(if)细化触发条件，仅在真正需要的时候执行取消动作。

---

典型生态项目集成

虽然此项目专注于工作流的取消功能，但它是整个Airflow及其GitHub Actions生态系统的一部分。在实际应用中，它常与其他监控、通知系统集成，例如使用GitHub的Issue Comment事件来及时反馈取消状态给团队成员。此外，结合Airflow本身进行更复杂的调度和任务管理，可以构建出强大的持续集成和部署流水线。

通过这种方式，airflow-cancel-workflow-runs不仅是减少资源浪费的工具，也是提高开发效率和保持自动化管道整洁的关键组件。正确集成这一Action，有助于提升团队的DevOps实践，确保每个工作流的高效运行。

airflow-cancel-workflow-runsFork of potiukcancel-workflow-runs action 项目地址:https://gitcode.com/gh_mirrors/ai/airflow-cancel-workflow-runs