版本、身份与核实范围
这是GitHub发布者仓库中的关联工作流参考文件.github/aw/github-agentic-workflows.md,原题为GitHub Agentic Workflows。2026-10-18 UTC核对完整正文、Git树路径与文件blob,并保留GitHub的MIT署名许可。它说明Markdown与YAML工作流的触发器、工具、权限和安全输出。旧Skill官方原文未核实;此参考文件没有Skill名称元数据,不计作旧SKILL.md恢复。相对链接及自引用链接指向发布者对应资料,关联文件正文、当前安装和工作流执行未实测。保留原目录显示名称、仓库、标识、安装命令及安装量。
完整关联参考(GitHub Agentic Workflows)
GitHub 代理式工作流
角色到模式快速对照表
这是与 triggers.md 中规范 决策矩阵 相同事实的角色视角视图;当触发器/工具/输出映射发生变化时,请同时更新两者。
| 角色 | 首选触发器与范围 | 典型读取工具 | 典型写入路径 | 显式 noop 规则 |
|---|---|---|---|---|
| 后端工程师 | pull_request,paths: 限定为迁移、schema 和 API 契约 |
github(gh-proxy) |
对当前 PR 范围内发现的问题使用 add-comment;仅对跨领域事件使用 create-issue |
当没有后端契约文件变更时使用 noop |
| 前端开发者 | pull_request,paths: 限定为 UI、设计令牌和资源文件 |
github(gh-proxy),可选 playwright,可选 cache-memory 用于基线 |
add-comment |
当没有 UI/令牌文件变更或未发现可操作的视觉/令牌问题时使用 noop |
| DevOps 工程师 | 对 GitHub Actions 失败使用 workflow_run,对外部部署失败使用 deployment_status |
github(gh-proxy),带 actions: read 或 deployments: read |
create-issue,带稳定去重键 |
当状态非终态、已自行恢复,或同一去重键已存在未关闭事件时使用 noop |
| 项目经理 | schedule(+ workflow_dispatch 用于预览和回填) |
github(gh-proxy) |
create-issue,带 close-older-issues: true 用于周期性摘要 |
当报告窗口内没有符合条件的更新时使用 noop |
| 设计师 | pull_request,paths: 限定为 UI、设计令牌、文案和资源文件 |
github(gh-proxy);可选 playwright 用于视觉检查 |
在 PR 上使用 add-comment |
当限定路径未变更或未发现可操作的设计/令牌问题时使用 noop |
| 法务 / 合规 | PR 审查使用 pull_request,paths: 限定为依赖清单或策略文档;周期性审计使用 schedule |
github(gh-proxy) |
对发现使用 add-comment;仅对需要团队范围跟进的问题使用 create-issue |
当没有范围内文件变更或所有发现均处于允许层级时使用 noop;升级前始终搜索是否存在未关闭的现有 issue |
角色到工具集对照表
| 角色 | 默认工具集足够的情况... | 需要指定可选工具的情况... |
|---|---|---|
| 项目经理 | 摘要/报告仅使用 GitHub 数据(tools.github.toolsets: [default]) |
仅当趋势基线/增量需要跨运行持久化时添加 cache-memory |
| 设计师 | PR 审查仅通过 GitHub 读取即可感知元数据/内容 | 添加 playwright 用于截图/视觉检查;当需要基线或快照历史时添加 cache-memory |
| 法务 / 合规 | 策略/依赖审查由仓库状态和元数据驱动 | 当周期性审计需要先前运行的证据/比较状态时添加 cache-memory |
替换先前结果
当周期性摘要或 PR 响应式更新被最新结果取代时,优先替换先前输出,而不是累积过期结果:
- 对于周期性 issue 摘要,使用
create-issue并设置close-older-issues: true。 - 对于滚动 PR 评论,使用
add-comment并设置hide-older-comments: true。
当只应存在一个活动 issue 或 PR 时,等待先前结果;当每个结果有意不同或需要保留历史时,保留先前输出。
文件格式
代理式工作流是带 YAML frontmatter 的 markdown 文件。
---
emoji: 🧠
name: My Workflow
description: Short description
on:
issues:
types: [opened]
permissions:
contents: read
actions: read
strict: true
network:
allowed: [defaults, github]
tools:
github:
mode: gh-proxy
toolsets: [default]
safe-outputs:
add-comment:
---
# Workflow Title
Natural language instructions for the AI agent.
重新编译规则
关于何时需要 gh aw compile,请参见 workflow-editing.md。
核心规则
- 生产工作流设置
strict: true。 - 将
bash访问限制为工作流实际需要的范围。 - 当写入完全由安全输出处理时,保持代理任务权限为只读。例如,
add-comment需要pull-requests: read来检查 PR,而不是pull-requests: write;create-issue需要issues: read来检查现有 issue,而不是issues: write。安全输出写入在具有各自权限的独立任务中运行。 - 对于视觉回归工作流,显式指定基线来源(例如
cache-memory键、artifact 或分支路径)。参见 visual-regression.md。
关于安全态势(只读任务、安全输出路由、gh-proxy/cli-proxy、网络约束、净化文本)、更安全替代模式以及常见风险领域,请参见 workflow-constraints.md。
仓库特定说明
使用 @.github/aw/instructions.md 作为工作流编写标准的规范仓库本地覆盖层。
- 此文件是可选的,由仓库拥有。
- 已安装的 gh-aw 代理应在存在时自动加载并应用它。
- 优先级:先应用上游默认值,再应用仓库覆盖规则;当两者冲突时,仓库覆盖规则优先。
触发器选择
使用与所请求自动化匹配的最小触发器。关于规范的触发器到用例映射,请参见 triggers.md 中的 决策矩阵;关于安全态势,请参见 workflow-constraints.md。
对于仅需要变更文件的检查,使用带 paths: 的 pull_request。当 PR 检查依赖另一个 Actions 工作流生成的 artifact 时,使用针对该工作流限定范围的 workflow_run,设置 types: [completed] 并以成功结论为条件,而不是在 pull_request 上与 artifact 生产者竞争。当审计必须跨运行关联结果,或独立于单个 PR 或 CI 运行检查漂移时,使用 schedule(并用 workflow_dispatch 进行手动运行)。
临时场景评估
已安装的 gh-aw 代理应支持不创建工作流文件的场景评估请求。
- 将诸如
agentic-workflows evaluate this scenario without creating files的提示视为临时评估模式。 - 对于明确的研究/评估请求,使用诸如
agentic-workflows evaluate this scenario without creating files或agentic-workflows research this workflow pattern and return recommendations only的措辞调用。 - 返回一份简洁的设计建议,涵盖触发器、范围、工具、权限、安全输出、
noop行为,以及任何报告窗口 / 分组 / 去重要求。 - 仅当用户要求继续时,才提议将建议转换为
.github/workflows/<workflow-id>.md。
支持的调用面
临时场景评估是已安装 agentic-workflows 自定义代理的对话模式能力,不是 CLI 标志或 MCP 工具参数——没有任何 gh aw CLI/MCP 命令接受自由形式的 prompt/scenario/query 参数。关于完整说明以及工具调用返回 Unknown parameter 时的恢复步骤,请参见 create-agentic-workflow.md 中的 调用面。
项目经理摘要示例
on:
schedule: weekly
workflow_dispatch:
permissions:
contents: read
issues: read
tools:
github:
mode: gh-proxy
toolsets: [default]
safe-outputs:
create-issue:
close-older-issues: true
- 报告窗口:7 天,截至运行时间;使用
workflow_dispatch进行预览、重跑或回填先前窗口。 - 分组维度:先按所属团队或仓库分组项目,再按状态(进行中、受阻、有风险)分组。
- 去重键示例:
pm-digest:<window-id>(例如pm-digest:2026-W33);与close-older-issues: true结合使用,使每次运行取代先前的摘要 issue,而不是累积重复项。 - 当报告窗口没有符合条件的更新时调用
noop。
非技术角色示例
触发器和写入路径与上方的角色到模式快速对照表相同。对于临时评估,还需收集:
| 角色 | 关键提示细节 |
|---|---|
| 项目经理 | 报告窗口、分组维度、稳定去重键,以及空窗口时使用 noop |
| 设计师 | 审查标准(可访问性、令牌一致性、资源策略);当限定文件未变更时使用 noop |
| 法务 / 合规 | 按策略层级分类;升级前去重;当没有范围内变更或违规时使用 noop |
带链接引用的 PR 检查
当 PR 分析需要验证或附加链接的 artifact(设计文档、策略链接、架构决策记录或批准)时,遵循以下简洁模式:
- 使用
gh pr view从 PR 正文或评论中读取链接引用(例如 URL、markdown 链接或类似ADR-NN的 ADR 引用令牌)。 - 验证链接——在评估合规性之前确认文档存在且可访问。
- 对结果分类:
- 链接存在且满足要求 → 使用
add-comment并附上 ✅ 摘要 - 链接存在但不满足要求 → 使用
add-comment指出具体差距 - 链接缺失 → 使用
add-comment请求提供,或在策略要求阻塞升级时使用create-issue
- 链接存在且满足要求 → 使用
- 调用
noop当 PR 不在范围内时(例如paths:守卫排除了所有变更文件)。
权限:仅 pull-requests: read;所有写入通过 add-comment 安全输出路由。
关于完整的依赖许可证/合规审查模式(路径范围限定、许可证层级分类、升级表),请参见 合规审查指南。
参考文件
| 主题 | 文件 |
|---|---|
| 编辑和重新编译规则 | workflow-editing.md |
| 架构和安全约束 | workflow-constraints.md |
| 常见设计模式 | workflow-patterns.md |
| Git 支持的工作队列调度器、worker 和 CLI 检查 | work-queue.md |
| Frontmatter schema 索引 | syntax.md |
| 安全输出索引 | safe-outputs.md |
| 触发器模式 | triggers.md |
上下文表达式和 {{#if}} 模板 |
context.md |
| 声明式引擎配置 | configure-agentic-engine.md |
| 代理运行时选择(Docker、Cloud Hypervisor、ARC DinD) | agent-runtime-instructions.md |
| 私有仓库 enclave(预览) | enclaves.md |
| CLI 命令和 MCP 等价项 | cli-commands.md |
| 网络配置 | network.md |
| 内存和持久化 | memory.md |
| Drive memory(私有预览) | drive-memory.md |
| 导入和共享组件 | reuse.md |
| 子代理 | subagents.md |
| 技能 | skills.md |
| Token 成本优化 | token-optimization.md |
| GitHub MCP 服务器配置 | github-mcp-server.md |
| GitHub MCP 服务器按工具集工具参考 | github-mcp-server-tools.md |
| GitHub MCP 服务器分页限制 | github-mcp-server-pagination.md |
| 编译器生成的任务、凭据和任务图 | jobs.md |
| 活动与 KPI 模式 | campaign.md |
| 实验与 A/B 测试 | experiments.md |
| 图表和 Python 数据可视化 | charts.md |
| LLM API 端点发现 | llms.md |
编译命令
gh aw compile
gh aw compile <workflow-id>
gh aw compile --purge
gh aw compile --strict
原文元数据
description: GitHub Agentic Workflows
applyTo: ".github/workflows/*.md,.github/workflows/**/*.md"
原作者与许可
MIT License
Copyright GitHub, Inc.
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.