[information-architecture] PR Labeler quick install hides required label customization
Nobody has claimed this yet.
Assessment
- Difficulty
- 2/5
- Estimated time
- Half a day
- Newbie friendliness
- 76/100
- Issue type
- Documentation
- Clarity
- Clearly specified
- Activity status
- Quiet
- Tech stack
- github-actions
- Domain
- documentation
Research direction
Start with the Quick Install section in gh-agent-workflows/pr-labeler/README.md and compare it with example.yml and .github/workflows/gh-aw-pr-labeler.md. Update the setup flow so label customization and the existing-label requirement appear before enabling the workflow, and make the sample taxonomy clearly a placeholder. Done means the README, example, and reusable-workflow documentation present consistent setup guidance.
Written by the indexing model from the issue text.
Description
Information Architecture Findings
1. PR Labeler quick install is separated from the required label picker
Area: Action placement / Picker placement
Component(s): gh-agent-workflows/pr-labeler/README.md, gh-agent-workflows/pr-labeler/example.yml, .github/workflows/gh-aw-pr-labeler.md
Problem: The PR Labeler README puts the copy/paste Quick Install command first (gh-agent-workflows/pr-labeler/README.md:9-17), but the workflow requires callers to choose repository-specific labels. That required classification-labels configuration is documented only afterward (gh-agent-workflows/pr-labeler/README.md:25-39) and again in the input table (gh-agent-workflows/pr-labeler/README.md:73-83). The example copied by Quick Install hardcodes small_boom,medium_boom,big_boom (gh-agent-workflows/pr-labeler/example.yml:16-33), while the reusable workflow marks classification-labels as required (.github/workflows/gh-aw-pr-labeler.md:36-39).
Users following the primary setup action can install an uncustomized label taxonomy before seeing the required picker/configuration step, which is especially confusing because labels must already exist in the target repository (gh-agent-workflows/pr-labeler/README.md:38-39).
Suggested improvement: Move the label-selection requirement into the Quick Install section, or change Quick Install into a short ordered setup flow: copy the trigger, replace classification-labels and additional-instructions with repo-specific labels, then ensure those labels exist before enabling the workflow.
Suggested Actions
- Update
gh-agent-workflows/pr-labeler/README.mdso Quick Install includes the required label customization step before users copy or enable the workflow. - Replace or annotate the hardcoded
small_boom,medium_boom,big_boomexample so it is clearly a placeholder taxonomy, not a ready-to-use default. - Add an explicit reminder near the install command that all configured labels must already exist in the target repository.
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