Skip to content

Commit 9398955

Browse files
Update gh-aw docs for setup and triggers
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
1 parent c48b410 commit 9398955

2 files changed

Lines changed: 4 additions & 3 deletions

File tree

docs/developing.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,8 +12,9 @@ Internal-only workflows (e.g., `upgrade-check.md`, `workflow-patrol.md`, `ci.yml
1212

1313
## Prerequisites
1414

15-
- [Go](https://go.dev/dl/)required by `make setup` to build the `gh-aw` compiler
15+
- [Go](https://go.dev/dl/)optional; only needed for non-release gh-aw compiler builds
1616
- [GitHub CLI (`gh`)](https://cli.github.com/) — installed automatically by `make setup` on Linux, but must be pre-installed on macOS
17+
- `curl` or `wget` — used to download the official gh-aw release compiler binary
1718

1819
Verify with:
1920

docs/workflows/gh-agent-workflows.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -196,7 +196,7 @@ setup-commands: |
196196

197197
Each workflow has two layers:
198198

199-
1. **Workflow** (`gh-aw-*.md` -> `gh-aw-*.lock.yml`): The agent logic, compiled by `gh-aw`. Triggers only on `workflow_call` with standard inputs (`additional-instructions`, `setup-commands`) and a `COPILOT_GITHUB_TOKEN` secret.
200-
2. **Trigger** (`<name>/example.yml`): A plain YAML file that defines the actual event triggers (schedule, PR events, slash commands, etc.) and calls the compiled `.lock.yml` via `uses:`. These serve as both examples for consumers and dogfood for this repo (copied to `.github/workflows/trigger-*.yml` by `scripts/dogfood.sh` for workflows not listed in `EXCLUDED_WORKFLOWS`).
199+
1. **Workflow** (`gh-aw-*.md` -> `gh-aw-*.lock.yml`): The agent logic, compiled by `gh-aw`. Workflows expose `workflow_call` with standard inputs (`additional-instructions`, `setup-commands`) and a `COPILOT_GITHUB_TOKEN` secret. Some source templates also declare direct comment/review/discussion triggers (`issue_comment`, `pull_request_review_comment`, `discussion_comment`) so the compiled workflow can be activated by reactions with the required permissions.
200+
2. **Trigger** (`<name>/example.yml`): A plain YAML file that defines the installable event wiring for each workflow (schedule, PR events, slash commands, etc.) and calls the compiled `.lock.yml` via `uses:`. These serve as both examples for consumers and dogfood for this repo (copied to `.github/workflows/trigger-*.yml` by `scripts/dogfood.sh` for workflows not listed in `EXCLUDED_WORKFLOWS`).
201201

202202
Consumer repos copy a workflow's `example.yml`, change the `uses:` path if needed, and customize the `with:` inputs. Updates propagate automatically when this repo updates the `v0` tag on release.

0 commit comments

Comments
 (0)