when running for a PR, improve in-issue reporting

Open
#100 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
4/5
Estimated time
3-5 days
Newbie friendliness
35/100
Issue type
Feature
Clarity
Mostly clear
Activity status
Stale
Domain
ci-cd, testing-qa

Research direction

Start by locating the code that triggers Pixel Eagle runs for pull requests. Add a nonce to each run's metadata, query the listed runs endpoint, and use each run's compare endpoint when differences are reported. Done means every run is reported in the issue with actual comparison results where needed.

Written by the indexing model from the issue text.

Description

  • when triggering for a PR, add a nonce as metadata to every pixel eagle run
  • once done, call api https://pixel-eagle.com/B25A040A-A980-4602-B90C-D480AB84076D/runs\?filter=nonce={nonce}
  • for every run, there will be an entry of the form
  {
    "project_id": "b25a040a-a980-4602-b90c-d480ab84076d",
    "id": 7563,
    "timestamp": 1737953544,
    "metadata": {
      "os": "macOS",
      "branch": "PR-17413",
      "gitref": "6911ddfd4b2d0f9efa6adba1605736112f7ef4f4"
      "nonce": "{nonce}",
    },
    "screenshot_count": 266,
    "compared_with": {
      "id": 7560,
      "changed": 8,
      "missing": 0
    }
  }
  • the counts in compared_with are done with a 0% tolerance and may not be the actual ones
  • to get the actual result, call https://pixel-eagle.com/B25A040A-A980-4602-B90C-D480AB84076D/runs/{id}/compare/{compared_with.id}
  • add nonce
  • call the list run API and report for every run
  • if there are diffs, check the actual results of the run
Dominant language
HTML
Stars
16
Forks
5
PR merge metrics
No merged PRs in 30d

Contributor guide

No contributing guide indexed for this repository

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 bevyengine/bevy-example-runner

All issues in bevyengine/bevy-example-runner

Similar issues

More DevOps issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.