-
Notifications
You must be signed in to change notification settings - Fork 296
Constrain agentic-workflows agent to single-file output #17479
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Changes from all commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change | ||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
|
@@ -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
|
||||||||||||||||
| - **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`. |
There was a problem hiding this comment.
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
.mdfile, but the same section also states workflows must be compiled to.lock.ymlfiles 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)”.