Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions .github/agents/agentic-workflows.agent.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Copy link

Copilot AI Feb 21, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This “Single-file output” note says to produce exactly one workflow .md file, but the same section also states workflows must be compiled to .lock.yml files before running. To avoid confusion (and agents skipping compilation/committing the lock), consider wording this as “no additional documentation files beyond the workflow .md (and its required .lock.yml)”.

Suggested change
- **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.
- **Single-file output**: When creating a workflow, do not create additional documentation files beyond the workflow `.md` (and its required `.lock.yml`). Avoid separate architecture docs, runbooks, usage guides, etc.; if documentation is needed, add a brief `## Usage` section inside the workflow file itself.

Copilot uses AI. Check for mistakes.
4 changes: 4 additions & 0 deletions .github/aw/create-agentic-workflow.md
Original file line number Diff line number Diff line change
Expand Up @@ -795,3 +795,7 @@ Include in the PR description:
- **Checkboxes**: Use `- [ ]` for unchecked and `- [x]` for checked task items
- **Progressive Disclosure**: Use `<details><summary><b>Bold Summary Text</b></summary>` 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/<workflow-id>.md` (with optional `## Usage` section inside)
Comment on lines +798 to +800
Copy link

Copilot AI Feb 21, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The new “Produce a single workflow file” rule could be read as “only create one file total”, which conflicts with earlier instructions in this doc to include both the source .github/workflows/<workflow-id>.md and the compiled .github/workflows/<workflow-id>.lock.yml in the PR. Consider clarifying that the single-file constraint is about avoiding additional docs (runbooks/architecture/etc.), and that the .lock.yml is still expected.

Suggested change
- **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/<workflow-id>.md` (with optional `## Usage` section inside)
- **Produce a single workflow _source_ file**: Always output exactly **one** workflow **source** `.md` file as the primary deliverable. This constraint is about avoiding additional documentation files (architecture docs, runbooks, usage guides, etc.) alongside the workflow source.
- The compiled lock file **is still required** and does **not** count against this “single source file” rule. You should expect `.github/workflows/<workflow-id>.lock.yml` to be present/committed along with the source `.md`.
- If documentation is needed, add a brief inline `## Usage` section within the same `.md` file.
-**Correct**: One workflow source file — `.github/workflows/<workflow-id>.md` (with optional `## Usage` section inside`)`, plus its compiled `.github/workflows/<workflow-id>.lock.yml`.

Copilot uses AI. Check for mistakes.
- ❌ **Incorrect**: `.github/workflows/<workflow-id>.md` + `docs/workflow-guide.md` + `README-workflow.md` + architecture docs