等待检查行动:智能工作流程同步器
2024-05-22 11:12:14作者:滑思眉Philip
wait-on-check-action
This action can be used to halt any workflow until required checks for a given ref (e.g., in a sibling workflow) pass successfully.
在GitHub上管理复杂的工作流时,你可能遇到一个挑战:如何确保任务按顺序执行,同时又保持并行性?这就是Wait On Check Action的用武之地。这是一个开源解决方案,它能让你的GitHub工作流程暂停,直到其他特定任务完成,然后再继续执行。
项目介绍
Wait On Check Action 是一个巧妙的GitHub动作,它通过 Checks API 定期轮询,检测指定的任务是否成功完成。一旦目标任务完成,整个工作流程将继续执行。这提供了一种绕过非相互依赖的工作流限制的方法,使你能够在确保依赖关系的同时,充分利用GitHub的并行运行功能。
项目技术分析
这个项目的实现基于Octokit库,利用了GitHub的Checks API来实时监控指定任务的状态。其主要功能包括:
- 智能等待:用户可以设置要等待的具体任务(由
check-name
参数指定)。 - 自动重试:通过
wait-interval
参数定义,定期检查任务状态,直到满足条件或超时。 - 可配置结论:默认情况下,只有“成功”和“跳过”的任务会被接受,但你可以通过
allowed-conclusions
自定义可接受的结论列表。 - 正则表达式过滤:如果你有多个类似命名的任务,可以通过
check-regexp
进行匹配筛选。
应用场景
假设你有一个工作流,既需要运行测试,也需要发布包。当新的推送到达时,测试应在发布之前完成。使用Wait On Check Action,你的“发布”工作流可以在测试完成后再开始运行,确保代码质量得到验证后才发布。
另一个例子是,你可能有一个外部服务(如Quay)构建镜像的触发器,该触发器在一个工作流中执行,而部署是在另一个工作流中。等镜像构建完成后,通过Webhook触发的“部署”工作流可以等待“测试”工作流的成功,保证安全的部署。
项目特点
- 灵活性:不仅支持GitHub主站,也支持GitHub企业版(GHE)。
- 易用性:只需简单几行YAML配置即可集成到现有工作流中。
- 可靠:使用API自动重试机制,即使面对延迟也不会错过任何状态更新。
- 可扩展性:允许用户自定义哪些任务结论被视为有效,以适应不同需求。
通过Wait On Check Action,你可以更自由地设计你的GitHub工作流,实现任务间的精确控制和灵活调度。无论你是个人开发者还是团队成员,这个开源项目都能帮助你优化代码管理和自动化流程,提高效率。立即尝试,并为你的GitHub工作流注入智能与秩序吧!
wait-on-check-action
This action can be used to halt any workflow until required checks for a given ref (e.g., in a sibling workflow) pass successfully.
热门项目推荐
相关项目推荐
- CangjieCommunity为仓颉编程语言开发者打造活跃、开放、高质量的社区环境Markdown6720
- redis-sdk仓颉语言实现的Redis客户端SDK。已适配仓颉0.53.4 Beta版本。接口设计兼容jedis接口语义,支持RESP2和RESP3协议,支持发布订阅模式,支持哨兵模式和集群模式。Cangjie32226
- Yi-CoderYi Coder 编程模型,小而强大的编程助手305
- qwerty-learner为键盘工作者设计的单词记忆与英语肌肉记忆锻炼软件 / Words learning and English muscle memory training software designed for keyboard workersTypeScript15.77 K1.48 K
- advanced-javaAdvanced-Java是一个Java进阶教程,适合用于学习Java高级特性和编程技巧。特点:内容深入、实例丰富、适合进阶学习。JavaScript75.83 K19.04 K
- taro开放式跨端跨框架解决方案,支持使用 React/Vue/Nerv 等框架来开发微信/京东/百度/支付宝/字节跳动/ QQ 小程序/H5/React Native 等应用。 https://taro.zone/TypeScript35.52 K4.79 K
- CommunityCangjie-TPC(Third Party Components)仓颉编程语言三方库社区资源汇总252
- Wwindows暂无简介Shell16.14 K1.35 K
- byzer-langByzer(以前的 MLSQL):一种用于数据管道、分析和人工智能的低代码开源编程语言。Scala1.88 K551
- AanacondaAnaconda turns your Sublime Text 3 in a full featured Python development IDE including autocompletion, code linting, IDE features, autopep8 formating, McCabe complexity checker Vagrant and Docker support for Sublime Text 3 using Jedi, PyFlakes, pep8, MyPy, PyLint, pep257 and McCabe that will never freeze your Sublime Text 3Python2.22 K263
热门内容推荐
展开
最新内容推荐
展开
项目优选
收起
CangjieCommunity
为仓颉编程语言开发者打造活跃、开放、高质量的社区环境
Markdown
672
0
RuoYi-Vue
🎉 基于SpringBoot,Spring Security,JWT,Vue & Element 的前后端分离权限管理系统,同时提供了 Vue3 的版本
Java
136
18
openHiTLS
旨在打造算法先进、性能卓越、高效敏捷、安全可靠的密码套件,通过轻量级、可剪裁的软件技术架构满足各行业不同场景的多样化要求,让密码技术应用更简单,同时探索后量子等先进算法创新实践,构建密码前沿技术底座!
C
12
8
redis-sdk
仓颉语言实现的Redis客户端SDK。已适配仓颉0.53.4 Beta版本。接口设计兼容jedis接口语义,支持RESP2和RESP3协议,支持发布订阅模式,支持哨兵模式和集群模式。
Cangjie
322
26
advanced-java
Advanced-Java是一个Java进阶教程,适合用于学习Java高级特性和编程技巧。特点:内容深入、实例丰富、适合进阶学习。
JavaScript
75.83 K
19.04 K
qwerty-learner
为键盘工作者设计的单词记忆与英语肌肉记忆锻炼软件 / Words learning and English muscle memory training software designed for keyboard workers
TSX
15.56 K
1.44 K
Jpom
🚀简而轻的低侵入式在线构建、自动部署、日常运维、项目监控软件
Java
1.41 K
292
Yi-Coder
Yi Coder 编程模型,小而强大的编程助手
HTML
30
5
easy-es
Elasticsearch
国内Top1 elasticsearch搜索引擎框架es ORM框架,索引全自动智能托管,如丝般顺滑,与Mybatis-plus一致的API,屏蔽语言差异,开发者只需要会MySQL语法即可完成对Es的相关操作,零额外学习成本.底层采用RestHighLevelClient,兼具低码,易用,易拓展等特性,支持es独有的高亮,权重,分词,Geo,嵌套,父子类型等功能...
Java
1.42 K
231
taro
开放式跨端跨框架解决方案,支持使用 React/Vue/Nerv 等框架来开发微信/京东/百度/支付宝/字节跳动/ QQ 小程序/H5/React Native 等应用。 https://taro.zone/
TypeScript
35.34 K
4.77 K