Skip to content

PR comment / check-run reporter — put the verdict where the PR is reviewed #77

Description

@justin808

Problem

Results land only as local files / CI artifacts (compare-results/report.html, report.json). There is no GitHub integration anywhere in packages/shaka-perf/src (no octokit, no check-run, no comment posting). So neither the human reviewer nor a reviewing agent sees "LCP +180ms (p=0.003), 2 visual changes" on the PR — someone must download and open an HTML artifact to know the verdict, which in practice means nobody does until it's a gate that already failed.

Direction

shaka-perf report-pr (CI-agnostic, driven by GITHUB_TOKEN + PR number env detection; callable from the GHA action and from CircleCI):

  • Posts/updates a sticky comment: overall verdict line (the existing failureSummary), a per-test table (chips + headline metric deltas with p-values once machine summaries land), and links to the uploaded report artifact / hosted report.
  • Optionally creates a check run so the verdict is a first-class status with annotations.
  • Markdown-only fallback (--out pr-comment.md) for CI systems where posting is handled by another step.

This is also the agent read-path in review workflows: an agent asked to "address the perf regression on this PR" can read the comment instead of re-running the suite.

Refs

#36 (evidence bundle — the comment should link the bundle), #7 (bundle-size artifact analysis), the GHA action issue.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions