Mutations
approveDeployments
Approve all pending deployments under one or more environments.
approveDeployments에 대한 입력 필드
input(ApproveDeploymentsInput!)
approveDeployments에 대한 반환 필드
| 이름 | 설명 |
|---|---|
| A unique identifier for the client performing the mutation. |
| The affected deployments. |
createDeployment
Creates a new deployment event.
createDeployment에 대한 입력 필드
input(CreateDeploymentInput!)
createDeployment에 대한 반환 필드
| 이름 | 설명 |
|---|---|
| True if the default branch has been auto-merged into the deployment ref. |
| A unique identifier for the client performing the mutation. |
| The new deployment. |
createDeploymentStatus
Create a deployment status.
createDeploymentStatus에 대한 입력 필드
input(CreateDeploymentStatusInput!)
createDeploymentStatus에 대한 반환 필드
| 이름 | 설명 |
|---|---|
| A unique identifier for the client performing the mutation. |
| The new deployment status. |
createEnvironment
Creates an environment or simply returns it if already exists.
createEnvironment에 대한 입력 필드
input(CreateEnvironmentInput!)
createEnvironment에 대한 반환 필드
| 이름 | 설명 |
|---|---|
| A unique identifier for the client performing the mutation. |
| The new or existing environment. |
deleteDeployment
Deletes a deployment.
deleteDeployment에 대한 입력 필드
input(DeleteDeploymentInput!)
deleteDeployment에 대한 반환 필드
| 이름 | 설명 |
|---|---|
| A unique identifier for the client performing the mutation. |
deleteEnvironment
Deletes an environment.
deleteEnvironment에 대한 입력 필드
input(DeleteEnvironmentInput!)
deleteEnvironment에 대한 반환 필드
| 이름 | 설명 |
|---|---|
| A unique identifier for the client performing the mutation. |
pinEnvironment
Pin an environment to a repository.
pinEnvironment에 대한 입력 필드
input(PinEnvironmentInput!)
pinEnvironment에 대한 반환 필드
| 이름 | 설명 |
|---|---|
| A unique identifier for the client performing the mutation. |
| The environment that was pinned. |
| The pinned environment if we pinned. |
rejectDeployments
Reject all pending deployments under one or more environments.
rejectDeployments에 대한 입력 필드
input(RejectDeploymentsInput!)
rejectDeployments에 대한 반환 필드
| 이름 | 설명 |
|---|---|
| A unique identifier for the client performing the mutation. |
| The affected deployments. |
reorderEnvironment
Reorder a pinned repository environment.
reorderEnvironment에 대한 입력 필드
input(ReorderEnvironmentInput!)
reorderEnvironment에 대한 반환 필드
| 이름 | 설명 |
|---|---|
| A unique identifier for the client performing the mutation. |
| The environment that was reordered. |
updateEnvironment
Updates an environment.
updateEnvironment에 대한 입력 필드
input(UpdateEnvironmentInput!)
updateEnvironment에 대한 반환 필드
| 이름 | 설명 |
|---|---|
| A unique identifier for the client performing the mutation. |
| The updated environment. |
Objects
DeployedEvent
Represents adeployedevent on a given pull request.
DeployedEvent 구현
DeployedEvent에 대한 필드
| 이름 | 설명 |
|---|---|
| Identifies the actor who performed the event. |
| Identifies the date and time when the object was created. |
| Identifies the primary key from the database. |
| The deployment associated with the |
| The Node ID of the DeployedEvent object. |
| PullRequest referenced by event. |
| The ref associated with the |
Deployment
Represents triggered deployment instance.
Deployment 구현
Deployment에 대한 필드
| 이름 | 설명 |
|---|---|
| Identifies the commit sha of the deployment. |
| Identifies the oid of the deployment commit, even if the commit has been deleted. |
| Identifies the date and time when the object was created. |
| Identifies the actor who triggered the deployment. |
| Identifies the primary key from the database. |
| The deployment description. |
| The latest environment to which this deployment was made. |
| The Node ID of the Deployment object. |
| The latest environment to which this deployment was made. |
| The latest status of this deployment. |
| The original environment to which this deployment was made. |
| Extra information that a deployment system might need. |
| Identifies the Ref of the deployment, if the deployment was created by ref. |
| Identifies the repository associated with the deployment. |
| The current state of the deployment. |
| A list of statuses associated with the deployment. |
| The deployment task. |
| Identifies the date and time when the object was last updated. |
DeploymentConnection
The connection type for Deployment.
DeploymentConnection에 대한 필드
| 이름 | 설명 |
|---|---|
| A list of edges. |
| A list of nodes. |
| Information to aid in pagination. |
| Identifies the total count of items in the connection. |
DeploymentEdge
An edge in a connection.
DeploymentEdge에 대한 필드
| 이름 | 설명 |
|---|---|
| A cursor for use in pagination. |
| The item at the end of the edge. |
DeploymentEnvironmentChangedEvent
Represents adeployment_environment_changedevent on a given pull request.
DeploymentEnvironmentChangedEvent 구현
DeploymentEnvironmentChangedEvent에 대한 필드
| 이름 | 설명 |
|---|---|
| Identifies the actor who performed the event. |
| Identifies the date and time when the object was created. |
| The deployment status that updated the deployment environment. |
| The Node ID of the DeploymentEnvironmentChangedEvent object. |
| PullRequest referenced by event. |
DeploymentProtectionRule
A protection rule.
DeploymentProtectionRule에 대한 필드
| 이름 | 설명 |
|---|---|
| Identifies the primary key from the database. |
| Whether deployments to this environment can be approved by the user who created the deployment. |
| The teams or users that can review the deployment. |
| The timeout in minutes for this protection rule. |
The type of protection rule. |
DeploymentProtectionRuleConnection
The connection type for DeploymentProtectionRule.
DeploymentProtectionRuleConnection에 대한 필드
| 이름 | 설명 |
|---|---|
| A list of edges. |
| A list of nodes. |
| Information to aid in pagination. |
| Identifies the total count of items in the connection. |
DeploymentProtectionRuleEdge
An edge in a connection.
DeploymentProtectionRuleEdge에 대한 필드
| 이름 | 설명 |
|---|---|
| A cursor for use in pagination. |
| The item at the end of the edge. |
DeploymentRequest
A request to deploy a workflow run to an environment.
DeploymentRequest에 대한 필드
| 이름 | 설명 |
|---|---|
| Whether or not the current user can approve the deployment. |
| The target environment of the deployment. |
| The teams or users that can review the deployment. |
| The wait timer in minutes configured in the environment. |
| The wait timer in minutes configured in the environment. |
DeploymentRequestConnection
The connection type for DeploymentRequest.
DeploymentRequestConnection에 대한 필드
| 이름 | 설명 |
|---|---|
| A list of edges. |
| A list of nodes. |
| Information to aid in pagination. |
| Identifies the total count of items in the connection. |
DeploymentRequestEdge
An edge in a connection.
DeploymentRequestEdge에 대한 필드
| 이름 | 설명 |
|---|---|
| A cursor for use in pagination. |
| The item at the end of the edge. |
DeploymentReview
A deployment review.
DeploymentReview 구현
DeploymentReview에 대한 필드
| 이름 | 설명 |
|---|---|
| The comment the user left. |
| Identifies the primary key from the database. |
| The environments approved or rejected. |
| The Node ID of the DeploymentReview object. |
| The decision of the user. |
| The user that reviewed the deployment. |
DeploymentReviewConnection
The connection type for DeploymentReview.
DeploymentReviewConnection에 대한 필드
| 이름 | 설명 |
|---|---|
| A list of edges. |
| A list of nodes. |
| Information to aid in pagination. |
| Identifies the total count of items in the connection. |
DeploymentReviewEdge
An edge in a connection.
DeploymentReviewEdge에 대한 필드
| 이름 | 설명 |
|---|---|
| A cursor for use in pagination. |
| The item at the end of the edge. |
DeploymentReviewerConnection
The connection type for DeploymentReviewer.
DeploymentReviewerConnection에 대한 필드
| 이름 | 설명 |
|---|---|
| A list of edges. |
| A list of nodes. |
| Information to aid in pagination. |
| Identifies the total count of items in the connection. |
DeploymentReviewerEdge
An edge in a connection.
DeploymentReviewerEdge에 대한 필드
| 이름 | 설명 |
|---|---|
| A cursor for use in pagination. |
| The item at the end of the edge. |
DeploymentStatus
Describes the status of a given deployment attempt.
DeploymentStatus 구현
DeploymentStatus에 대한 필드
| 이름 | 설명 |
|---|---|
| Identifies the date and time when the object was created. |
| Identifies the actor who triggered the deployment. |
| Identifies the deployment associated with status. |
| Identifies the description of the deployment. |
| Identifies the environment of the deployment at the time of this deployment status. |
| Identifies the environment URL of the deployment. |
| The Node ID of the DeploymentStatus object. |
| Identifies the log URL of the deployment. |
| Identifies the current state of the deployment. |
| Identifies the date and time when the object was last updated. |
DeploymentStatusConnection
The connection type for DeploymentStatus.
DeploymentStatusConnection에 대한 필드
| 이름 | 설명 |
|---|---|
| A list of edges. |
| A list of nodes. |
| Information to aid in pagination. |
| Identifies the total count of items in the connection. |
DeploymentStatusEdge
An edge in a connection.
DeploymentStatusEdge에 대한 필드
| 이름 | 설명 |
|---|---|
| A cursor for use in pagination. |
| The item at the end of the edge. |
Environment
An environment.
Environment 구현
Environment에 대한 필드
| 이름 | 설명 |
|---|---|
| Identifies the primary key from the database. |
| The Node ID of the Environment object. |
| Indicates whether or not this environment is currently pinned to the repository. |
| The latest completed deployment with status success, failure, or error if it exists. |
| The name of the environment. |
| The position of the environment if it is pinned, null if it is not pinned. |
| The protection rules defined for this environment. |
EnvironmentConnection
The connection type for Environment.
EnvironmentConnection에 대한 필드
| 이름 | 설명 |
|---|---|
| A list of edges. |
| A list of nodes. |
| Information to aid in pagination. |
| Identifies the total count of items in the connection. |
EnvironmentEdge
An edge in a connection.
EnvironmentEdge에 대한 필드
| 이름 | 설명 |
|---|---|
| A cursor for use in pagination. |
| The item at the end of the edge. |
PinnedEnvironment
Represents a pinned environment on a given repository.
PinnedEnvironment 구현
PinnedEnvironment에 대한 필드
| 이름 | 설명 |
|---|---|
| Identifies the date and time when the pinned environment was created. |
| Identifies the primary key from the database. |
| Identifies the environment associated. |
| The Node ID of the PinnedEnvironment object. |
| Identifies the position of the pinned environment. |
| The repository that this environment was pinned to. |
PinnedEnvironmentConnection
The connection type for PinnedEnvironment.
PinnedEnvironmentConnection에 대한 필드
| 이름 | 설명 |
|---|---|
| A list of edges. |
| A list of nodes. |
| Information to aid in pagination. |
| Identifies the total count of items in the connection. |
PinnedEnvironmentEdge
An edge in a connection.
PinnedEnvironmentEdge에 대한 필드
| 이름 | 설명 |
|---|---|
| A cursor for use in pagination. |
| The item at the end of the edge. |
RequiredDeploymentsParameters
Choose which environments must be successfully deployed to before refs can be pushed into a ref that matches this rule.
RequiredDeploymentsParameters에 대한 필드
| 이름 | 설명 |
|---|---|
| The environments that must be successfully deployed to before branches can be merged. |
Enums
DeploymentOrderField
Properties by which deployment connections can be ordered.
DeploymentOrderField의 값
| 이름 | 설명 |
|---|---|
CREATED_AT | Order collection by creation time. |
DeploymentProtectionRuleType
The possible protection rule types.
DeploymentProtectionRuleType의 값
| 이름 | 설명 |
|---|---|
BRANCH_POLICY | Branch policy. |
REQUIRED_REVIEWERS | Required reviewers. |
WAIT_TIMER | Wait timer. |
DeploymentReviewState
The possible states for a deployment review.
DeploymentReviewState의 값
| 이름 | 설명 |
|---|---|
APPROVED | The deployment was approved. |
REJECTED | The deployment was rejected. |
DeploymentState
The possible states in which a deployment can be.
DeploymentState의 값
| 이름 | 설명 |
|---|---|
ABANDONED | The pending deployment was not updated after 30 minutes. |
ACTIVE | The deployment is currently active. |
DESTROYED | An inactive transient deployment. |
ERROR | The deployment experienced an error. |
FAILURE | The deployment has failed. |
INACTIVE | The deployment is inactive. |
IN_PROGRESS | The deployment is in progress. |
PENDING | The deployment is pending. |
QUEUED | The deployment has queued. |
SUCCESS | The deployment was successful. |
WAITING | The deployment is waiting. |
DeploymentStatusState
The possible states for a deployment status.
DeploymentStatusState의 값
| 이름 | 설명 |
|---|---|
ERROR | The deployment experienced an error. |
FAILURE | The deployment has failed. |
INACTIVE | The deployment is inactive. |
IN_PROGRESS | The deployment is in progress. |
PENDING | The deployment is pending. |
QUEUED | The deployment is queued. |
SUCCESS | The deployment was successful. |
WAITING | The deployment is waiting. |
EnvironmentOrderField
Properties by which environments connections can be ordered.
EnvironmentOrderField의 값
| 이름 | 설명 |
|---|---|
NAME | Order environments by name. |
EnvironmentPinnedFilterField
Properties by which environments connections can be ordered.
EnvironmentPinnedFilterField의 값
| 이름 | 설명 |
|---|---|
ALL | All environments will be returned. |
NONE | Environments exclude pinned will be returned. |
ONLY | Only pinned environment will be returned. |
PinnedEnvironmentOrderField
Properties by which pinned environments connections can be ordered.
PinnedEnvironmentOrderField의 값
| 이름 | 설명 |
|---|---|
POSITION | Order pinned environments by position. |
Unions
DeploymentReviewer
Users and teams.
DeploymentReviewer에 가능한 유형
Input objects
ApproveDeploymentsInput
Autogenerated input type of ApproveDeployments.
ApproveDeploymentsInput에 대한 입력 필드
| 이름 | 설명 |
|---|---|
| A unique identifier for the client performing the mutation. |
| Optional comment for approving deployments. |
| The ids of environments to reject deployments. |
| The node ID of the workflow run containing the pending deployments. |
CreateDeploymentInput
Autogenerated input type of CreateDeployment.
CreateDeploymentInput에 대한 입력 필드
| 이름 | 설명 |
|---|---|
| Attempt to automatically merge the default branch into the requested ref, defaults to true. |
| A unique identifier for the client performing the mutation. |
| Short description of the deployment. |
| Name for the target deployment environment. |
| JSON payload with extra information about the deployment. |
| The node ID of the ref to be deployed. |
| The node ID of the repository. |
| The status contexts to verify against commit status checks. To bypass required contexts, pass an empty array. Defaults to all unique contexts. |
| Specifies a task to execute. |
CreateDeploymentStatusInput
Autogenerated input type of CreateDeploymentStatus.
CreateDeploymentStatusInput에 대한 입력 필드
| 이름 | 설명 |
|---|---|
| Adds a new inactive status to all non-transient, non-production environment deployments with the same repository and environment name as the created status's deployment. |
| A unique identifier for the client performing the mutation. |
| The node ID of the deployment. |
| A short description of the status. Maximum length of 140 characters. |
| If provided, updates the environment of the deploy. Otherwise, does not modify the environment. |
| Sets the URL for accessing your environment. |
| The log URL to associate with this status. This URL should contain output to keep the user updated while the task is running or serve as historical information for what happened in the deployment. |
| The state of the deployment. |
CreateEnvironmentInput
Autogenerated input type of CreateEnvironment.
CreateEnvironmentInput에 대한 입력 필드
| 이름 | 설명 |
|---|---|
| A unique identifier for the client performing the mutation. |
| The name of the environment. |
| The node ID of the repository. |
DeleteDeploymentInput
Autogenerated input type of DeleteDeployment.
DeleteDeploymentInput에 대한 입력 필드
| 이름 | 설명 |
|---|---|
| A unique identifier for the client performing the mutation. |
| The Node ID of the deployment to be deleted. |
DeleteEnvironmentInput
Autogenerated input type of DeleteEnvironment.
DeleteEnvironmentInput에 대한 입력 필드
| 이름 | 설명 |
|---|---|
| A unique identifier for the client performing the mutation. |
| The Node ID of the environment to be deleted. |
DeploymentOrder
Ordering options for deployment connections.
DeploymentOrder에 대한 입력 필드
| 이름 | 설명 |
|---|---|
| The ordering direction. |
| The field to order deployments by. |
Environments
Ordering options for environments.
Environments에 대한 입력 필드
| 이름 | 설명 |
|---|---|
| The direction in which to order environments by the specified field. |
| The field to order environments by. |
PinEnvironmentInput
Autogenerated input type of PinEnvironment.
PinEnvironmentInput에 대한 입력 필드
| 이름 | 설명 |
|---|---|
| A unique identifier for the client performing the mutation. |
| The ID of the environment to modify. |
| The desired state of the environment. If true, environment will be pinned. If false, it will be unpinned. |
PinnedEnvironmentOrder
Ordering options for pinned environments.
PinnedEnvironmentOrder에 대한 입력 필드
| 이름 | 설명 |
|---|---|
| The direction in which to order pinned environments by the specified field. |
| The field to order pinned environments by. |
RejectDeploymentsInput
Autogenerated input type of RejectDeployments.
RejectDeploymentsInput에 대한 입력 필드
| 이름 | 설명 |
|---|---|
| A unique identifier for the client performing the mutation. |
| Optional comment for rejecting deployments. |
| The ids of environments to reject deployments. |
| The node ID of the workflow run containing the pending deployments. |
ReorderEnvironmentInput
Autogenerated input type of ReorderEnvironment.
ReorderEnvironmentInput에 대한 입력 필드
| 이름 | 설명 |
|---|---|
| A unique identifier for the client performing the mutation. |
| The ID of the environment to modify. |
| The desired position of the environment. |
RequiredDeploymentsParametersInput
Choose which environments must be successfully deployed to before refs can be pushed into a ref that matches this rule.
RequiredDeploymentsParametersInput에 대한 입력 필드
| 이름 | 설명 |
|---|---|
| The environments that must be successfully deployed to before branches can be merged. |
UpdateEnvironmentInput
Autogenerated input type of UpdateEnvironment.
UpdateEnvironmentInput에 대한 입력 필드
| 이름 | 설명 |
|---|---|
| A unique identifier for the client performing the mutation. |
| The node ID of the environment. |
| Whether deployments to this environment can be approved by the user who created the deployment. |
| The ids of users or teams that can approve deployments to this environment. |
| The wait timer in minutes. |