Always compile after any workflow .md change to keep .lock.yml in sync#44565
Conversation
…in sync Co-authored-by: pelikhan <4175913+pelikhan@users.noreply.github.com>
|
PR Triage - Run 29041860272. Category: docs | Risk: Low | Score: 65/100 | Action: fast_track. DRAFT. Always compile after workflow .md changes to keep .lock.yml in sync (15+/4-, 2 files). Prevents stale lock files — operationally important. Undraft and fast-track after CI.
|
🤖 PR Triage — Run §29061171191
Auto-compile after workflow .md changes to keep .lock.yml in sync. DRAFT but high-value — prevents a common developer error. Undraft and fast-track for review.
|
There was a problem hiding this comment.
Pull request overview
This PR updates gh-aw’s agent-facing workflow editing/update guidance to clarify that even when body-only workflow edits don’t require recompilation for runtime behavior, gh aw compile must still be run to keep generated .lock.yml metadata (e.g., body_hash) in sync.
Changes:
- Reframed the “no recompile” guidance to explicitly scope it to runtime behavior while adding an explicit “always compile” rule for metadata sync.
- Updated the update prompt’s validation flow and added final steps to ensure compilation happens and
.lock.ymlis included in PRs.
Show a summary per file
| File | Description |
|---|---|
| .github/aw/workflow-editing.md | Clarifies runtime vs metadata implications and adds an “always compile” rule after any change. |
| .github/aw/update-agentic-workflow.md | Updates decision/validation guidance and adds final steps to ensure .lock.yml stays in sync via compilation. |
Review details
Tip
Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
- Files reviewed: 2/2 changed files
- Comments generated: 2
- Review effort level: Low
| Body changes take effect on the next run. | ||
|
|
||
| **Always run `gh aw compile` after any change** (frontmatter or body) to keep `.lock.yml` metadata in sync. | ||
|
|
| ## Validation Flow | ||
|
|
||
| - always inspect the workflow before editing | ||
| - compile after frontmatter changes | ||
| - always compile after any change to keep `.lock.yml` in sync | ||
| - keep the workflow valid at every step | ||
| - summarize what changed and whether recompilation was needed |
|
🎉 This pull request is included in a new release. Release: |
Agents following the update instructions would skip
gh aw compilefor body-only changes, leaving.lock.ymlmetadata (e.g.body_hash) stale.update-agentic-workflow.mdcompile after frontmatter changes→always compile after any change to keep .lock.yml in sync.lock.ymlin PR (mirrorscreate-agentic-workflow.md)workflow-editing.mdNo Recompile Needed→No Recompile Required for Runtime Behaviorto preserve the accurate distinction while eliminating the misleading implication that compile can be skippedgh aw compileafter any change (frontmatter or body) to keep.lock.ymlmetadata in sync"After frontmatter changes, review the generated .lock.yml→After any change, review the generated .lock.yml