Skip to content

Commit 3f59af7

Browse files
committed
docs: add gh-aw guidance for agents
1 parent 0dd9d54 commit 3f59af7

1 file changed

Lines changed: 12 additions & 0 deletions

File tree

AGENTS.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
# AGENTS.md
2+
3+
## Agentic Workflow Sources
4+
5+
When changing GitHub Agentic Workflow source files under
6+
`.github/workflows/`, run `gh aw compile` before committing and
7+
include the regenerated `.lock.yml` files in the same change.
8+
9+
This applies to workflow markdown files such as `.github/workflows/*.md`
10+
and shared workflow markdown such as `.github/workflows/shared/*.md`.
11+
The `gh-aw lock check` CI job runs the same compile step and fails if
12+
the generated workflow files are stale.

0 commit comments

Comments
 (0)