docs(aw): elevate workflow recompilation to a critical invariant#47863
Merged
Conversation
Co-authored-by: pelikhan <4175913+pelikhan@users.noreply.github.com>
Copilot
AI
changed the title
docs: emphasize compile invariant in .github/aw instructions
docs(aw): elevate workflow recompilation to a critical invariant
Jul 24, 2026
Copilot created this pull request from a session on behalf of
pelikhan
July 24, 2026 21:21
View session
pelikhan
approved these changes
Jul 24, 2026
Contributor
There was a problem hiding this comment.
Pull request overview
Elevates workflow recompilation to a mandatory repository instruction.
Changes:
- Adds a critical invariant requiring recompilation after workflow Markdown edits.
- Documents watch mode for iterative editing.
Show a summary per file
| File | Description |
|---|---|
.github/aw/instructions.md |
Adds mandatory workflow recompilation guidance. |
Review details
Tip
Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
- Files reviewed: 1/1 changed files
- Comments generated: 1
- Review effort level: Medium
|
|
||
| Add your repository-specific standards here, for example: | ||
|
|
||
| - **CRITICAL INVARIANT:** After **any** modification to agentic workflow markdown files (`.github/workflows/*.md`), you **must** run `gh aw compile` (or `gh aw compile --watch` while iterating) before stopping. Treat this as mandatory. |
Contributor
|
🎉 This pull request is included in a new release. Release: |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This updates the
.github/awrepository overlay to make post-edit compilation of agentic workflow markdown a hard requirement. The goal is to prevent drift between.mdsources and compiled workflow state.Problem framing
What changed
/home/runner/work/gh-aw/gh-aw/.github/aw/instructions.md.gh aw compileafter any modification to.github/workflows/*.md.gh aw compile --watchas the iterative path during active editing.Resulting guidance (snippet)