feat: add agentic workflow to guard documentation tone of voice - #1135
feat: add agentic workflow to guard documentation tone of voice#1135vdstrizhkova wants to merge 1 commit into
Conversation
- add agentic-workflows agent and supporting skills (designer + workflows) - add mcp.json and copilot-setup-steps workflow to run the agent in CI 🤖 - Generated by Copilot
| - Workflow files: `.github/workflows/*.md` and `.github/workflows/**/*.md` | ||
| - Workflow lock files: `.github/workflows/*.lock.yml` | ||
| - Shared components: `.github/workflows/shared/*.md` | ||
| - Configuration: `.github/aw/github-agentic-workflows.md` |
There was a problem hiding this comment.
This dispatcher references many .github/aw/*.md paths throughout the file (create-agentic-workflow.md, debug-agentic-workflow.md, network.md, patterns.md, token-optimization.md, github-agentic-workflows.md, cli-commands.md, report.md, dependabot.md, test-coverage.md, etc.). None of those files exist in this repo — they live in github/gh-aw. As written, the agent will follow dead links. Either vendor the referenced files into this repo, or rewrite every reference to point to https://github.com/github/gh-aw/blob/main/.github/aw/... (as the designer skill already does in its "Portable HTTPS references" section)
There was a problem hiding this comment.
Pull request overview
This PR adds GitHub Agentic Workflows (gh-aw) automation scaffolding under .github/ (agent + skills + MCP config + setup workflow), intended to support agentic workflow usage in this repository (per PR description, to enforce documentation tone-of-voice consistency going forward).
Changes:
- Adds a
copilot-setup-stepsGitHub Actions workflow to install/configure the gh-aw CLI extension for Copilot Agent runs. - Adds an “Agentic Workflows” dispatcher agent plus supporting routing and “workflow designer” skills.
- Adds an MCP server configuration to expose
gh aw mcp-server.
Reviewed changes
Copilot reviewed 5 out of 5 changed files in this pull request and generated 5 comments.
Show a summary per file
| File | Description |
|---|---|
.github/workflows/copilot-setup-steps.yml |
Adds CI setup steps for Copilot Agent runs (checkout + gh-aw setup). |
.github/skills/agentic-workflows/SKILL.md |
Adds a router/dispatcher skill for gh-aw workflow-related requests. |
.github/skills/agentic-workflow-designer/SKILL.md |
Adds an interview-style skill to design workflows before generating a workflow .md. |
.github/mcp.json |
Configures an MCP server backed by gh aw mcp-server. |
.github/agents/agentic-workflows.md |
Adds an agent definition to route gh-aw workflow tasks to the right prompts/guides. |
Suppressed comments (1)
.github/skills/agentic-workflows/SKILL.md:80
- This line references
skills/otel-queries/SKILL.md, but that file does not exist in the repo (and the path also omits the.github/prefix used elsewhere in this skill). As written, it will send users/agents to a dead reference.
When the task involves OTEL, OTLP, traces, observability backends, or telemetry-driven analysis, also read and follow `skills/otel-queries/SKILL.md` after loading the matching workflow prompt or skill.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
|
|
||
| - `.github/skills/agentic-workflow-designer/SKILL.md` | ||
| After loading the matching workflow prompt or skill, follow it directly: | ||
| - Design workflows from scratch via interview: `skills/agentic-workflow-designer/SKILL.md` |
| Use this before `.github/aw/create-agentic-workflow.md` when requirements are unclear or incomplete. | ||
|
|
||
| - Use `skills/agentic-workflow-designer/SKILL.md` to discover and confirm requirements. | ||
| - Use `.github/aw/create-agentic-workflow.md` once requirements are clear and ready for implementation. | ||
| - Use `.github/aw/agentic-chat.md` when the user wants a specification/pseudo-code instead of a runnable workflow file. |
| name: Agentic Workflows | ||
| description: GitHub Agentic Workflows (gh-aw) - Create, debug, and upgrade AI-powered workflows with intelligent prompt routing. | ||
| disable-model-invocation: true |
| ## Available Prompts | ||
|
|
| @@ -0,0 +1,11 @@ | |||
| { | |||
| "mcpServers": { | |||
| "github-agentic-workflows": { | |||
|
|
||
| Follow up: | ||
| - **"Any third-party services or MCP servers to include (for example Slack, Jira, Datadog, custom internal MCP)?"** | ||
| - **"Are you deploying on GitHub.com, GHEC with custom endpoints, or GHES?"** |
There was a problem hiding this comment.
I think this is not relevant for this repository
| @@ -0,0 +1,224 @@ | |||
| --- | |||
There was a problem hiding this comment.
Thanks for splitting this out of #1130. Before going further, could we discuss the direction? The files added look like a general-purpose assistant for authoring gh-aw workflows rather than something specific to the repository tone of voice.
Pull Request Template
What are you trying to address
This is part 3 of 3 splitting PR #1130. It adds the agentic workflow that guards documentation tone of voice - the automation tooling only, no doc content.
Scope: 5 files changed (+679).
What's included
.github/agents/agentic-workflows.md- agent definition that reviews docs for tone-of-voice consistency..github/skills/agentic-workflow-designer/SKILL.mdand.github/skills/agentic-workflows/SKILL.md- supporting skills..github/mcp.json- MCP server configuration for the agent..github/workflows/copilot-setup-steps.yml- CI setup so the agent can run.This lets the tone-of-voice standard applied manually in #1133 be enforced automatically going forward.
Checklist
READY TO PR? Use the check-list below to ensure your branch is ready for PR.