Reference documentation for GraphQL schema types in the Actions category.
A workflow contains meta information about an Actions workflow file.
Implements: Node, UniformResourceLocatable
WorkflowcreatedAt (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.
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.orderBy (WorkflowRunOrder): Ordering options for the connection. Default: {field: CREATED_AT, direction: DESC}.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.
A workflow that must run for this rule to pass.
WorkflowFileReferencepath (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.A workflow that must run for this rule to pass.
WorkflowFileReferenceInputpath (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.A workflow run.
Implements: Node, UniformResourceLocatable
WorkflowRuncheckSuite (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. (Pagination: after, before, first, last)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. (Pagination: after, before, first, last)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!): 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.The connection type for WorkflowRun.
WorkflowRunConnectionedges ([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.An edge in a connection.
WorkflowRunEdgecursor (String!): A cursor for use in pagination.node (WorkflowRun): The item at the end of the edge.An executed workflow file for a workflow run.
Implements: Node, UniformResourceLocatable
WorkflowRunFileid (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.Ways in which lists of workflow runs can be ordered upon return.
WorkflowRunOrderdirection (OrderDirection!): The direction in which to order workflow runs by the specified field.field (WorkflowRunOrderField!): The field by which to order workflows.Properties by which workflow run connections can be ordered.
WorkflowRunOrderFieldCREATED_AT: Order workflow runs by most recently created.Require all changes made to a targeted branch to pass the specified workflows before they can be merged.
WorkflowsParametersdoNotEnforceOnCreate (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.Require all changes made to a targeted branch to pass the specified workflows before they can be merged.
WorkflowsParametersInputdoNotEnforceOnCreate (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.The possible states for a workflow.
WorkflowStateACTIVE: 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.