elastic / elastic/ai-github-actions
[information-architecture] Docs examples omit required Copilot permission
- Dominant language
- Python
- Stars
- 11
- Forks
- 16
- Avg merge
- 22h 9m
- Merged PRs (30d)
- 31
Description
## Information Architecture Findings
### 1. Per-workflow example blocks omit the required Copilot permission
**Area:** Action placement / Progressive disclosure
**Component(s):** `docs/workflows/gh-agent-workflows/*.md`, `gh-agent-workflows/*/example.yml`, `docs/workflows/gh-agent-workflows.md`
**Problem:** The per-workflow docs put copyable `permissions:` examples in each workflow page, but at least 15 of those visible examples omit `copilot-requests: write`. The source install examples users get from each page's Quick install command include that permission, and the overview explains it is required for Copilot-backed workflow billing.
Evidence:
- `docs/workflows/gh-agent-workflows/pr-review.md:47-52` shows the PR Review example permissions without `copilot-requests: write`, while `gh-agent-workflows/pr-review/example.yml:6-11` includes it.
- `docs/workflows/gh-agent-workflows/bugs.md:63-67` shows the Bug Hunter example permissions without `copilot-requests: write`, while `gh-agent-workflows/bug-hunter/example.yml:7-12` includes it.
- `docs/workflows/gh-agent-workflows/issue-triage.md:52-58` omits it, while `gh-agent-workflows/issue-triage/example.yml:6-12` includes it.
- `docs/workflows/gh-agent-workflows/pr-actions-detective.md:49-54` omits it, while `gh-agent-workflows/pr-actions-detective/example.yml:7-12` includes it.
- `docs/workflows/gh-agent-workflows.md:128-130` says workflows are configured with `copilot-requests: write` because it enables organization-level Copilot billing through `GITHUB_TOKEN`.
Users who copy the visible docs-page example instead of the downloaded `example.yml` can create a workflow that looks complete but lacks the Copilot permission needed by the current workflow model. The required permission is documented globally, but not where users make the copy/paste decision.
**Suggested improvement:** Sync the docs-page example workflow blocks with their corresponding `gh-agent-workflows/*/example.yml` files, or replace the repeated inline YAML blocks with a direct instruction to copy and customize the canonical `example.yml` so the required permission stays adjacent to the setup action.
## Suggested Actions
- [ ] Add `copilot-requests: write` to the per-workflow docs examples that call `gh-aw-*.lock.yml@v0`.
- [ ] Add a generation/check step so docs examples cannot drift from the canonical `gh-agent-workflows/*/example.yml` permissions blocks.
---
[What is this?](https://ela.st/github-ai-tools) | [From workflow: Trigger Information Architecture](https://github.com/elastic/ai-github-actions/actions/runs/28254915181)
Give us feedback! React with 🚀 if perfect, 👍 if helpful, 👎 if not.
Contributor guide
Research direction
Compare the inline examples in docs/workflows/gh-agent-workflows/*.md and docs/workflows/gh-agent-workflows.md with the canonical gh-agent-workflows/*/example.yml files, starting with the examples cited in the issue. Verify which workflows call gh-aw-*.lock.yml@v0 and inspect how the documentation examples are maintained. Done means every relevant visible permissions block includes copilot-requests: write or clearly directs users to the canonical example without drifting from it.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- github-actions
- Domain
- ci-cd, documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Quiet
- Clarity
- Clearly specified
- Newbie friendliness
- 72/100