Skip to content

frontend-triage: simplify and refresh the README - #6530

Merged
msujaws merged 1 commit into
mozilla:masterfrom
msujaws:frontend-triage-readme-refresh
Aug 6, 2026
Merged

frontend-triage: simplify and refresh the README#6530
msujaws merged 1 commit into
mozilla:masterfrom
msujaws:frontend-triage-readme-refresh

Conversation

@msujaws

@msujaws msujaws commented Aug 6, 2026

Copy link
Copy Markdown
Contributor

The frontend-triage README had grown into a narrative doc. Roughly 30 lines
explained why Searchfox permalinks resolve from the index revision rather
than the checkout — which the module docstring in
libs/hackbot-runtime/hackbot_runtime/searchfox.py already covers in full —
plus similar standalone rationale for model pinning and the read-only design.
This trims it toward the terser style of the build-repair and test-repair
READMEs and folds the safety bullets into a single section about what actually
reaches Bugzilla.

It also fixes three stale points:

  • Feedback channel. The README predates frontend-triage: invite feedback via Bugzilla reactions and tags #6519, so it never mentioned the
    runtime's 👍/👎 reaction footer or the four ai-triage-* tags appended by
    feedback_tags_hook. Every needinfo reference is gone.
  • BROKER_URL was missing from the inputs table even though AgentInputs
    requires it. The table now also makes clear that BUGZILLA_API_URL /
    BUGZILLA_API_KEY are consumed by the broker container only.
  • Recorded actions are not auto-applied for this agent — a human applies
    them from the Hackbot UI.

Smaller corrections: rules/ and prompts/ live under
hackbot_agents/frontend_triage/, not at the agent root, which the old text
left ambiguous; and a closing line notes the agent has no unit tests of its own.

Net 65 insertions / 81 deletions, one file, prettier-clean.

Conflicts with #6439

#6439 ("Auto-apply high-confidence frontend-triage results and report them to
Slack") edits the same README section and inverts the auto-apply claim above.
Whichever lands second will need a fixup — the wording here is correct against
master today, and #6439's own README hunk already describes the
auto_apply_confidence behavior that supersedes it.

Verification

Documentation only. Claims were checked against config.py, __main__.py,
agent.py (feedback_tags_hook), hackbot_runtime/actions/bugzilla.py
(_COMMENT_FOOTER), compose.yml (BROKER_URL), and
services/hackbot-api/app/agents.py. The agent was not run end to end, so the
footer and tag line are confirmed by reading the hooks rather than by
inspecting a real summary.json.

The README had drifted into a narrative doc: ~30 lines explained why
Searchfox permalinks resolve from the index revision rather than the
checkout, duplicating the module docstring in hackbot_runtime/searchfox.py,
plus similar rationale for model pinning and the read-only design.

Trim that back to the terser style of the build-repair and test-repair
READMEs, and fix three stale points:

- The recorded comment now ends with the runtime's 👍/👎 reaction footer
  plus the ai-triage-* tags added by feedback_tags_hook. Needinfo is no
  longer the feedback channel.
- BROKER_URL was missing from the inputs table, though AgentInputs
  requires it.
- Recorded actions are applied by a human from the Hackbot UI; this agent
  does not set auto_apply_actions.

Also note that rules/ and prompts/ live under hackbot_agents/frontend_triage/,
and that the agent has no unit tests of its own.
@msujaws
msujaws requested a review from a team as a code owner August 6, 2026 20:16
@msujaws
msujaws requested a review from crythms August 6, 2026 20:16

@crythms crythms left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks

@msujaws
msujaws enabled auto-merge (rebase) August 6, 2026 20:22
@msujaws
msujaws merged commit 8b6490b into mozilla:master Aug 6, 2026
8 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants