API reference
Get a GitHub workflow run
One GitHub Actions workflow run of one of the account's repositories, through the account's installation of InOrbit's GitHub App: its status, conclusion (empty until completed), head sha, head branch, event and creation time, and behind_main, true only when the run's head is a strict ancestor of the default branch's head (not equal to it, not diverged). behind_main_observation says whether that was observed or why not, and main_head_sha is the commit it was judged against. An unknown run is not found; a repository the account's installation does not list is permission denied.
Needs scope connections:read.
bearerAuthorizationBearer <JWT>An access token from the identity provider: a person's, or a customer's from the client credentials grant with an API key (developers.inorbit.hr). The gateway verifies it; the audience is iohr-api.
org_id*stringThe account's id: org in GET /v1/me.
run_id*stringThe workflow run's id, as GitHub numbers it, a decimal string.
repository?stringThe repository, owner/name.
iohr.connections.v1.GetGithubWorkflowRunResponse
application/json- response
iohr.connections.v1.GetGithubWorkflowRunResponse
behind_main*booleanbehind_main_observation?iohr.connections.v1.GithubObservation
conclusion*stringcreated_at*stringdefault_branch*stringevent*stringevidence_id*stringhead_branch*stringhead_sha*stringmain_head_sha*stringobserved_at*stringrepository*stringrun_id*stringstatus*stringimport { ApiError, Public } from "@inorbithr/sdk";// Reads INORBIT_TOKEN, or INORBIT_KEY_ID and INORBIT_KEY_SECRET.const api = Public.fromEnv();try { const { value } = await api.connections.getGithubWorkflowRun("<org_id>", "<run_id>"); console.log(value);} catch (e) { if (!(e instanceof ApiError)) throw e; console.error(`${e.code}: ${e.problem} (request id ${e.raw.requestId})`); process.exitCode = 1;}npm install @inorbithr/sdk. Calls the package's public surface; an operation newer than your package needs the next release or a client generated for your account. The SDKs.
{ "behind_main": true, "behind_main_observation": { "detail": "string", "evidence_id": "string", "observed": true, "reason": "string" }, "conclusion": "string", "created_at": "string", "default_branch": "string", "event": "string", "evidence_id": "string", "head_branch": "string", "head_sha": "string", "main_head_sha": "string", "observed_at": "string", "repository": "string", "run_id": "string", "status": "string"}