Reference documentation for GraphQL schema types in the Actions category.

Dans cet article

Objects

Workflow

Object

A workflow contains meta information about an Actions workflow file.

Workflow Met en œuvre

Champs pour Workflow

NomDescription

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 pour 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.

Champs pour WorkflowFileReference

NomDescription

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 Met en œuvre

Champs pour WorkflowRun

NomDescription

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 pour 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.

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 pour 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.

runNumber (Int!)

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

updatedAt (DateTime!)

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

url (URI!)

The HTTP URL for this workflow run.

workflow (Workflow!)

The workflow executed in this workflow run.

WorkflowRunConnection

Object

The connection type for WorkflowRun.

Champs pour WorkflowRunConnection

NomDescription

edges ([WorkflowRunEdge])

A list of edges.

nodes ([WorkflowRun])

A list of nodes.

pageInfo (PageInfo!)

Information to aid in pagination.

totalCount (Int!)

Identifies the total count of items in the connection.

WorkflowRunEdge

Object

An edge in a connection.

Champs pour WorkflowRunEdge

NomDescription

cursor (String!)

A cursor for use in pagination.

node (WorkflowRun)

The item at the end of the edge.

WorkflowRunFile

Object

An executed workflow file for a workflow run.

WorkflowRunFile Met en œuvre

Champs pour WorkflowRunFile

NomDescription

id (ID!)

The Node ID of the WorkflowRunFile object.

path (String!)

The path of the workflow file relative to its repository.

repositoryFileUrl (URI!)

The direct link to the file in the repository which stores the workflow file.

repositoryName (URI!)

The repository name and owner which stores the workflow file.

resourcePath (URI!)

The HTTP path for this workflow run file.

run (WorkflowRun!)

The parent workflow run execution for this file.

url (URI!)

The HTTP URL for this workflow run file.

viewerCanPushRepository (Boolean!)

If the viewer has permissions to push to the repository which stores the workflow.

viewerCanReadRepository (Boolean!)

If the viewer has permissions to read the repository which stores the workflow.

WorkflowsParameters

Object

Require all changes made to a targeted branch to pass the specified workflows before they can be merged.

Champs pour WorkflowsParameters

NomDescription

doNotEnforceOnCreate (Boolean!)

Allow repositories and branches to be created if a check would otherwise prohibit it.

workflows ([WorkflowFileReference!]!)

Workflows that must pass for this rule to pass.

Enums

WorkflowRunOrderField

Enum

Properties by which workflow run connections can be ordered.

Valeurs pour WorkflowRunOrderField.

NomDescription
CREATED_AT

Order workflow runs by most recently created.

WorkflowState

Enum

The possible states for a workflow.

Valeurs pour WorkflowState.

NomDescription
ACTIVE

The workflow is active.

DELETED

The workflow was deleted from the git repository.

DISABLED_FORK

The workflow was disabled by default on a fork.

DISABLED_INACTIVITY

The workflow was disabled for inactivity in the repository.

DISABLED_MANUALLY

The workflow was disabled manually.

Input objects

WorkflowFileReferenceInput

Input object

A workflow that must run for this rule to pass.

Champs d’entrée pour WorkflowFileReferenceInput

NomDescription

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.

WorkflowRunOrder

Input object

Ways in which lists of workflow runs can be ordered upon return.

Champs d’entrée pour WorkflowRunOrder

NomDescription

direction (OrderDirection!)

The direction in which to order workflow runs by the specified field.

field (WorkflowRunOrderField!)

The field by which to order workflows.

WorkflowsParametersInput

Input object

Require all changes made to a targeted branch to pass the specified workflows before they can be merged.

Champs d’entrée pour WorkflowsParametersInput

NomDescription

doNotEnforceOnCreate (Boolean)

Allow repositories and branches to be created if a check would otherwise prohibit it.

workflows ([WorkflowFileReferenceInput!]!)

Workflows that must pass for this rule to pass.