diff --git a/.github/agents/agentic-workflows.agent.md b/.github/agents/agentic-workflows.agent.md index 7c3daeea29a..34ea6500cc1 100644 --- a/.github/agents/agentic-workflows.agent.md +++ b/.github/agents/agentic-workflows.agent.md @@ -152,3 +152,4 @@ gh aw compile --validate - Workflows must be compiled to `.lock.yml` files before running in GitHub Actions - **Bash tools are enabled by default** - Don't restrict bash commands unnecessarily since workflows are sandboxed by the AWF - Follow security best practices: minimal permissions, explicit network access, no template injection +- **Single-file output**: When creating a workflow, produce exactly **one** workflow `.md` file. Do not create separate documentation files (architecture docs, runbooks, usage guides, etc.). If documentation is needed, add a brief `## Usage` section inside the workflow file itself. diff --git a/.github/aw/create-agentic-workflow.md b/.github/aw/create-agentic-workflow.md index 286412873e4..2bc449ba243 100644 --- a/.github/aw/create-agentic-workflow.md +++ b/.github/aw/create-agentic-workflow.md @@ -795,3 +795,7 @@ Include in the PR description: - **Checkboxes**: Use `- [ ]` for unchecked and `- [x]` for checked task items - **Progressive Disclosure**: Use `
Bold Summary Text` to collapse long content - **Workflow Run Links**: Format as `[ยง12345](https://github.com/owner/repo/actions/runs/12345)`. Do NOT add footer attribution (system adds automatically) +- **Produce a single workflow file**: Always output exactly **one** workflow `.md` file as the primary deliverable. Do not create separate architecture documents, runbooks, usage guides, or any other documentation files alongside the workflow. + - If documentation is needed, add a brief inline `## Usage` section within the same `.md` file. + - โœ… **Correct**: One file โ€” `.github/workflows/.md` (with optional `## Usage` section inside) + - โŒ **Incorrect**: `.github/workflows/.md` + `docs/workflow-guide.md` + `README-workflow.md` + architecture docs