Actions

Reference documentation for GraphQL schema types in the Actions category.

In this article

Objects

Workflow

Object

A workflow contains meta information about an Actions workflow file.

Workflow Implements

Fields for Workflow

NameDescription

createdAt (DateTime!)

Identifies the date and time when the object was created.

databaseId (Int)

Identifies the primary key from the database.

id (ID!)

The Node ID of the Workflow object.

name (String!)

The name of the workflow.

resourcePath (URI!)

The HTTP path for this workflow.

runs (WorkflowRunConnection!)

The runs of the workflow.

Arguments for runs

  • after (String)

    Returns the elements in the list that come after the specified cursor.

  • before (String)

    Returns the elements in the list that come before the specified cursor.

  • first (Int)

    Returns the first n elements from the list.

  • last (Int)

    Returns the last n elements from the list.

state (WorkflowState!)

The state of the workflow.

updatedAt (DateTime!)

Identifies the date and time when the object was last updated.

url (URI!)

The HTTP URL for this workflow.

WorkflowFileReference

Object

A workflow that must run for this rule to pass.

Fields for WorkflowFileReference

NameDescription

path (String!)

The path to the workflow file.

ref (String)

The ref (branch or tag) of the workflow file to use.

repositoryId (Int!)

The ID of the repository where the workflow is defined.

sha (String)

The commit SHA of the workflow file to use.

WorkflowRun

Object

A workflow run.

WorkflowRun Implements

Fields for WorkflowRun

NameDescription

checkSuite (CheckSuite!)

The check suite this workflow run belongs to.

createdAt (DateTime!)

Identifies the date and time when the object was created.

databaseId (Int)

Identifies the primary key from the database.

deploymentReviews (DeploymentReviewConnection!)

The log of deployment reviews.

Arguments for deploymentReviews

  • after (String)

    Returns the elements in the list that come after the specified cursor.

  • before (String)

    Returns the elements in the list that come before the specified cursor.

  • first (Int)

    Returns the first n elements from the list.

  • last (Int)

    Returns the last n elements from the list.

displayTitle (String)

The human-readable title of the workflow run.

event (String!)

The event that triggered the workflow run.

file (WorkflowRunFile)

The workflow file.

id (ID!)

The Node ID of the WorkflowRun object.

pendingDeploymentRequests (DeploymentRequestConnection!)

The pending deployment requests of all check runs in this workflow run.

Arguments for pendingDeploymentRequests

  • after (String)

    Returns the elements in the list that come after the specified cursor.

  • before (String)

    Returns the elements in the list that come before the specified cursor.

  • first (Int)

    Returns the first n elements from the list.

  • last (Int)

    Returns the last n elements from the list.

resourcePath (URI!)

The HTTP path for this workflow run.

runAttempt (Int!)

The attempt number of this workflow run.

runNumber (Int!)

A number that uniquely identifies this workflow run in its parent workflow.

updatedAt (DateTime!)