Create release (GraphQL)

createRelease(input: CreateReleaseInput!): CreateReleasePayload

Requires project.releases.write.

Arguments

ArgumentTypeRequired
inputCreateReleaseInput!Yes

Input fields

input

CreateReleaseInput

FieldTypeRequired
nameStringNo
projectReferenceStringNo
branchReferenceStringNo

Response

Returns CreateReleasePayload. Open the type for its fields and nested types.

FieldTypeDescription
idID!
nameString
versionStringSemver version, for example 1.2.3. Null for releases created before versioning.
projectIdID
userIdIDAccount that created the release.
exportOutcomeReleaseOutcomeExport outcome; null when no export status is recorded.
buildOutcomeReleaseOutcomeBuild outcome; completion does not imply deployment. Null when no build status is recorded.
deployOutcomeReleaseOutcomeRecorded deployment outcome, or null when no deployment status is recorded. Creating a release does not deploy it.

All fields of CreateReleasePayload.

Types marked with ! cannot be null. Lists use [Type] notation. The type index lists all published input and response types.

Example

graphql
mutation CreateRelease($input: CreateReleaseInput!) {
  createRelease(input: $input) {
    id
    projectId
    name
    createdAt
    updatedAt
  }
}
json
{
  "input": {
    "projectReference": "00000000-0000-4000-8000-000000000001"
  }
}