Checks and reviews

The two things you cannot get from your own machine: the build ran on the forge, and the reviews were left there. Both are asked live rather than read from what a webhook happened to leave, because “is it green now” is the question somebody blocking on it has.

Checks

endpoint

One entry per repository the card has a pull request open in.

[
  {
    "repository": "acme/api",
    "branchName": "feature/7-rotate-the-signing-key",
    "runs": [
      {
        "id": "4471",
        "name": "build",
        "state": "failing",
        "url": "https://github.com/acme/api/runs/4471",
        "summary": "2 tests failed",
        "notes": [
          {
            "path": "src/keys.ts",
            "line": 88,
            "level": "failure",
            "message": "expected the old key to be revoked"
          }
        ]
      }
    ],
    "error": null
  }
]

object[]

The file and line a failing check pointed at — the useful part of a red build. Gathered only for failing runs, and capped at twenty: a build that failed five hundred times is not five hundred things to read.

Reviews

endpoint

[
  {
    "repository": "acme/api",
    "prNumber": 412,
    "reviews": [
      { "author": "marina", "state": "changes_requested", "body": "The key is still logged." }
    ],
    "error": null
  }
]

When one repository cannot be asked

A card can touch three repositories where one connection has lapsed. That one comes back carrying its reason; the other two still answer.

[
  { "repository": "acme/api", "runs": [], "error": null },
  { "repository": "acme/legacy", "runs": null, "error": "Not Found" }
]

runs: null with an error is not the same as runs: []. The first is the forge not answering; the second is the forge saying nothing is running. Treating them alike is how a dashboard reports a green build that nobody ever ran.

A caller handed a single 500 for the whole set would learn nothing about either repository, which is why the failure is per entry.

A card with nothing open

An empty list, not a 404. The card exists and no pull request has been opened on it — which is an answer, and a different one from “no such card”, which is still 404.

⌘I

Overview

Endpoints

Checks and reviews

Checks

Reviews

When one repository cannot be asked

A card with nothing open

​Checks

​Reviews

​When one repository cannot be asked

​A card with nothing open

Checks

Reviews

When one repository cannot be asked

A card with nothing open