diff --git a/.github/aw/update-agentic-workflow.md b/.github/aw/update-agentic-workflow.md index df08540cfef..4cd86e4ab61 100644 --- a/.github/aw/update-agentic-workflow.md +++ b/.github/aw/update-agentic-workflow.md @@ -37,7 +37,7 @@ This prompt is for **updating existing workflows only**. For new workflows, use Use [workflow-editing.md](workflow-editing.md) as the source of truth. - frontmatter change → recompilation required -- markdown-body-only change → no recompilation required +- markdown-body-only change → no recompilation required for runtime behavior, but always compile to keep `.lock.yml` in sync ## Update Rules @@ -98,10 +98,16 @@ network: ## 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 +## Final Steps + +1. compile with `gh aw compile ` +2. fix all compile errors +3. include the updated `.lock.yml` in the PR + ## Final Message Rules At the end, tell the user: diff --git a/.github/aw/workflow-editing.md b/.github/aw/workflow-editing.md index ef093ba9166..da0bc3bf921 100644 --- a/.github/aw/workflow-editing.md +++ b/.github/aw/workflow-editing.md @@ -24,7 +24,9 @@ Run `gh aw compile ` after changing: - `mcp-servers:` - engine, timeout, concurrency, or other YAML configuration -## No Recompile Needed +## No Recompile Required for Runtime Behavior + +Body-only edits take effect on the next run without recompilation. Edit the markdown body directly for: @@ -36,6 +38,8 @@ Edit the markdown body directly for: 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 Commands ```bash @@ -51,8 +55,9 @@ Use `--strict` for production-quality validation. - Smallest change that satisfies the request. - Preserve structure unless reorganization is the task. - Never leave a workflow broken. +- Always run `gh aw compile ` after any change (frontmatter or body) to keep `.lock.yml` in sync. - If compile fails, fix all errors before stopping. -- After frontmatter changes, review the generated `.lock.yml`. +- After any change, review the generated `.lock.yml`. ## Prompt-Authoring Rules