首页
/ 等待检查行动:智能工作流程同步器

等待检查行动:智能工作流程同步器

2024-05-22 11:12:14作者:滑思眉Philip

在GitHub上管理复杂的工作流时,你可能遇到一个挑战:如何确保任务按顺序执行,同时又保持并行性?这就是Wait On Check Action的用武之地。这是一个开源解决方案,它能让你的GitHub工作流程暂停,直到其他特定任务完成,然后再继续执行。

项目介绍

Wait On Check Action 是一个巧妙的GitHub动作,它通过 Checks API 定期轮询,检测指定的任务是否成功完成。一旦目标任务完成,整个工作流程将继续执行。这提供了一种绕过非相互依赖的工作流限制的方法,使你能够在确保依赖关系的同时,充分利用GitHub的并行运行功能。

项目技术分析

这个项目的实现基于Octokit库,利用了GitHub的Checks API来实时监控指定任务的状态。其主要功能包括:

  1. 智能等待:用户可以设置要等待的具体任务(由check-name参数指定)。
  2. 自动重试:通过wait-interval参数定义,定期检查任务状态,直到满足条件或超时。
  3. 可配置结论:默认情况下,只有“成功”和“跳过”的任务会被接受,但你可以通过allowed-conclusions自定义可接受的结论列表。
  4. 正则表达式过滤:如果你有多个类似命名的任务,可以通过check-regexp进行匹配筛选。

应用场景

假设你有一个工作流,既需要运行测试,也需要发布包。当新的推送到达时,测试应在发布之前完成。使用Wait On Check Action,你的“发布”工作流可以在测试完成后再开始运行,确保代码质量得到验证后才发布。

另一个例子是,你可能有一个外部服务(如Quay)构建镜像的触发器,该触发器在一个工作流中执行,而部署是在另一个工作流中。等镜像构建完成后,通过Webhook触发的“部署”工作流可以等待“测试”工作流的成功,保证安全的部署。

项目特点

  1. 灵活性:不仅支持GitHub主站,也支持GitHub企业版(GHE)。
  2. 易用性:只需简单几行YAML配置即可集成到现有工作流中。
  3. 可靠:使用API自动重试机制,即使面对延迟也不会错过任何状态更新。
  4. 可扩展性:允许用户自定义哪些任务结论被视为有效,以适应不同需求。

通过Wait On Check Action,你可以更自由地设计你的GitHub工作流,实现任务间的精确控制和灵活调度。无论你是个人开发者还是团队成员,这个开源项目都能帮助你优化代码管理和自动化流程,提高效率。立即尝试,并为你的GitHub工作流注入智能与秩序吧!

登录后查看全文
热门项目推荐