关于 github-actions
用于创建和排查 GitHub Actions 工作流及自定义 Action 的指南。它强调检查日志和实际参数、本地测试,以及减少不必要的 CI 运行。
主要功能
- 01自定义 Action 部署指导
- 02工作流调试步骤
- 03使用 act 本地测试
- 04规划精简复现方案
- 05安全与权限注意事项
适用场景
- 01排查失败的工作流运行
- 02在 CI 前本地测试工作流
- 03配置权限及处理 fork PR
安装
复制下面的命令,在终端中运行。
$
npx skills add https:/ / github.com/ openhands/ extensions --skill github-actions安装后在 Claude Code 中输入/github-actions确认已加载。
附带文件.plugin/plugin.jsonREADME.md
详细介绍
GitHub Actions 指南
关键规则
自定义 Action 部署:
- 新的自定义 Action 必须先合并到 main 分支才能使用
- 首次合并后,应从功能分支进行测试
调试步骤: 在以下情况下,添加用于打印非机密参数的调试步骤:
- 创建新 Action 时,或
- 排查特别棘手的问题时
(无需用于每个工作流;按需使用)
效率原则
Action 会消耗 CI 分钟数。务必审慎规划,不要反复尝试:
- 监控,而非轮询——使用
gh run watch/gh pr checks --watch实时跟踪运行 - 查看日志,而非猜测——修改代码前,先获取失败作业的日志
- 打印实际值——调试步骤会显示真实的
inputs/github上下文,而非你的假设 - 先在本地测试——
act可在你的机器上运行工作流,避免浪费 CI 分钟数 - 规划最小复现——先使用单个作业、最小矩阵和狭窄的触发条件,再逐步扩展
请参阅 README.md,了解完整的调试工作流、gh 命令和 YAML 调试步骤示例。
关键注意事项
- Fork PR 中无法使用密钥——
pull_request不会向 Fork 提供密钥;pull_request_target可以,但绝不可在其中检出或执行 Fork PR 代码(这会造成拥有写入权限的远程代码执行漏洞) - 固定 Action 版本——使用
@v4或 SHA,而非@main(以防出现破坏性变更) - 显式设置权限——为 GITHUB_TOKEN 操作设置
permissions:块 - 使用制品在作业间传递数据——若不使用
upload-artifact/download-artifact,文件不会在作业之间保留
评论
支持 Markdown