Struct WorkflowJob

Source

pub struct WorkflowJob {Show 23 fields
    pub check_run_url: String,
    pub completed_at: Option<DateTime<Utc>>,
    pub conclusion: Option<WorkflowJobConclusion>,
    pub created_at: DateTime<Utc>,
    pub head_branch: Option<String>,
    pub head_sha: String,
    pub html_url: String,
    pub id: i64,
    pub labels: Vec<String>,
    pub name: String,
    pub node_id: String,
    pub run_attempt: i64,
    pub run_id: f64,
    pub run_url: String,
    pub runner_group_id: Option<i64>,
    pub runner_group_name: Option<String>,
    pub runner_id: Option<i64>,
    pub runner_name: Option<String>,
    pub started_at: DateTime<Utc>,
    pub status: WorkflowJobStatus,
    pub steps: Vec<WorkflowStep>,
    pub url: String,
    pub workflow_name: Option<String>,
}

Expand description

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.

JSON schema

{
 "title": "Workflow Job",
 "description": "The workflow job. Many `workflow_job` keys, such as `head_sha`, `conclusion`, and `started_at` are the same as those in a [`check_run`](#check_run) object.",
 "type": "object",
 "required": [
   "check_run_url",
   "completed_at",
   "conclusion",
   "created_at",
   "head_branch",
   "head_sha",
   "html_url",
   "id",
   "labels",
   "name",
   "node_id",
   "run_attempt",
   "run_id",
   "run_url",
   "runner_group_id",
   "runner_group_name",
   "runner_id",
   "runner_name",
   "started_at",
   "status",
   "steps",
   "url",
   "workflow_name"
 ],
 "properties": {
   "check_run_url": {
     "type": "string",
     "format": "uri"
   },
   "completed_at": {
     "oneOf": [
       {
         "type": "string",
         "format": "date-time"
       },
       {
         "type": "null"
       }
     ]
   },
   "conclusion": {
     "type": [
       "string",
       "null"
     ],
     "enum": [
       "success",
       "failure",
       "cancelled",
       "skipped",
       null
     ]
   },
   "created_at": {
     "type": "string",
     "format": "date-time"
   },
   "head_branch": {
     "description": "The name of the current branch.",
     "type": [
       "string",
       "null"
     ]
   },
   "head_sha": {
     "type": "string"
   },
   "html_url": {
     "type": "string",
     "format": "uri"
   },
   "id": {
     "type": "integer"
   },
   "labels": {
     "description": "Custom labels for the job. Specified by the [`\"runs-on\"` attribute](https://docs.github.com/en/actions/reference/workflow-syntax-for-github-actions#jobsjob_idruns-on) in the workflow YAML.",
     "type": "array",
     "items": {
       "type": "string"
     }
   },
   "name": {
     "type": "string"
   },
   "node_id": {
     "type": "string"
   },
   "run_attempt": {
     "type": "integer"
   },
   "run_id": {
     "type": "number"
   },
   "run_url": {
     "type": "string",
     "format": "uri"
   },
   "runner_group_id": {
     "description": "The ID of the runner group that is running this job. This will be `null` as long as `workflow_job[status]` is `queued`.",
     "type": [
       "integer",
       "null"
     ]
   },
   "runner_group_name": {
     "description": "The name of the runner group that is running this job. This will be `null` as long as `workflow_job[status]` is `queued`.",
     "type": [
       "string",
       "null"
     ]
   },
   "runner_id": {
     "description": "The ID of the runner that is running this job. This will be `null` as long as `workflow_job[status]` is `queued`.",
     "type": [
       "integer",
       "null"
     ]
   },
   "runner_name": {
     "description": "The name of the runner that is running this job. This will be `null` as long as `workflow_job[status]` is `queued`.",
     "type": [
       "string",
       "null"
     ]
   },
   "started_at": {
     "type": "string",
     "format": "date-time"
   },
   "status": {
     "description": "The current status of the job. Can be `queued`, `in_progress`, or `completed`.",
     "type": "string",
     "enum": [
       "queued",
       "in_progress",
       "completed",
       "waiting"
     ]
   },
   "steps": {
     "type": "array",
     "items": {
       "$ref": "#/definitions/workflow-step"
     }
   },
   "url": {
     "type": "string",
     "format": "uri"
   },
   "workflow_name": {
     "description": "The name of the workflow.",
     "type": [
       "string",
       "null"
     ]
   }
 },
 "additionalProperties": false,
 "$schema": "http://json-schema.org/draft-07/schema"
}

Fields§

§check_run_url: String§completed_at: Option<DateTime<Utc>>§conclusion: Option<WorkflowJobConclusion>§created_at: DateTime<Utc>§head_branch: Option<String>

The name of the current branch.

§head_sha: String§html_url: String§id: i64§labels: Vec<String>

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