[information-architecture] Detector/fixer chaining quick-start hides required workflow permissions
Nobody has claimed this yet.
Assessment
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Newbie friendliness
- 78/100
- Issue type
- Documentation
- Clarity
- Clearly specified
- Activity status
- Quiet
- Tech stack
- github-actions
- Domain
- ci-cd, documentation
Research direction
Start with docs/workflows/detector-fixer-chaining.md:18-35 and compare its primary chaining snippet with the permissions blocks at lines 7-11 of the four example-chained.yml files. Add the required in-context permissions guidance and keep the late-page note as reinforcement. Done means the first copy/paste path clearly covers write scopes for issue and pull-request creation.
Written by the indexing model from the issue text.
Description
Information Architecture Findings
1. Chaining quick-start snippet omits required permissions in the primary setup path
Area: Action placement / Progressive disclosure
Component(s): docs/workflows/detector-fixer-chaining.md, gh-agent-workflows/bug-hunter/example-chained.yml, gh-agent-workflows/code-complexity-detector/example-chained.yml, gh-agent-workflows/code-duplication-detector/example-chained.yml, gh-agent-workflows/test-coverage-detector/example-chained.yml
Problem: The first "How it works" chaining snippet is positioned as the primary copy/paste setup path, but it does not include a permissions: block. The required permission guidance is deferred to a late-page note, so users can complete setup from the top of the page and miss a control that governs whether the fixer can actually write PR changes.
Evidence:
docs/workflows/detector-fixer-chaining.md:18-35shows the initial detector→fixer snippet withoutpermissions:.docs/workflows/detector-fixer-chaining.md:179introduces required permission guidance much later ("union of both workflows' permissions").- Chained examples in workflow directories place permissions near the top:
gh-agent-workflows/bug-hunter/example-chained.yml:7-11gh-agent-workflows/code-complexity-detector/example-chained.yml:7-11gh-agent-workflows/code-duplication-detector/example-chained.yml:7-11gh-agent-workflows/test-coverage-detector/example-chained.yml:7-11
Suggested improvement: Move permission requirements into the first chaining snippet (or immediately adjacent callout) so the required control is in-context at the moment users copy setup instructions.
Suggested Actions
- Add a
permissions:block to the first chaining snippet indocs/workflows/detector-fixer-chaining.md. - Add a brief in-context note before the snippet stating that chaining requires write scopes for both issue creation and PR creation.
- Keep the late-page note, but make it reinforcement instead of first disclosure.
What is this? | From workflow: Trigger Information Architecture
Give us feedback! React with 🚀 if perfect, 👍 if helpful, 👎 if not.
- Dominant language
- Python
- Stars
- 11
- Forks
- 16
- Avg merge
- 11h 16m
- Merged PRs (30d)
- 29
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from elastic/ai-github-actions
-
Difficulty 1/5 Under an hour Newbie friendliness 92/100
elastic/ai-github-actions#2142 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 88/100
elastic/ai-github-actions#2132 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 88/100
elastic/ai-github-actions#2127 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
elastic/ai-github-actions#2126 ·
-
Difficulty 1/5 Under an hour Newbie friendliness 92/100
elastic/ai-github-actions#2121 ·
All issues in elastic/ai-github-actions
Similar issues
-
Difficulty 2/5 1-3 hours Newbie friendliness 88/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 82/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
-
enhancement
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 74/100