[information-architecture] PR Labeler quick install hides required label customization

Open Beginner friendly
#1,491 0 comments 0 reactions 0 assignees View on GitHub

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.md so 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_boom example 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

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from elastic/ai-github-actions

All issues in elastic/ai-github-actions

Similar issues

More Python issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.