Skip to main content
The Deno 2 Release Candidate is here
Learn more
Module

x/actionify/src/deps/octokit-types.ts>WorkflowJob

Create and manage your GitHub workflows with TypeScript and Deno.
ifiokjr/actionify
Latest
interface WorkflowJob
import { type WorkflowJob } from "https://deno.land/x/actionify@0.3.0/src/deps/octokit-types.ts";

The workflow job. Many workflow_job keys, such as head_sha, conclusion, and started_at are the same as those in a check_run object.

Properties

id: number
run_id: number
run_attempt: number
run_url: string
head_sha: string
node_id: string
name: string
check_run_url: string
html_url: string
url: string
status: "queued" | "in_progress" | "completed"

The current status of the job. Can be queued, in_progress, or completed.

steps: WorkflowStep[]
conclusion:
| "success"
| "failure"
| "cancelled"
| "skipped"
| null
labels: string[]

Custom labels for the job. Specified by the "runs-on" attribute in the workflow YAML.

runner_id: number | null

The ID of the runner that is running this job. This will be null as long as workflow_job[status] is queued.

runner_name: string | null

The name of the runner that is running this job. This will be null as long as workflow_job[status] is queued.

runner_group_id: number | null

The ID of the runner group that is running this job. This will be null as long as workflow_job[status] is queued.

runner_group_name: string | null

The name of the runner group that is running this job. This will be null as long as workflow_job[status] is queued.

started_at: string
completed_at: string | null