Interface DeploymentData

DeploymentData

Data related to a specific deployment in a specific environment that the deployment is present in. Must specify one of issueKeys or associations.

interface DeploymentData {
    associations?: ({
        associationType: "issueKeys" | "issueIdOrKeys";
        values: string[];
    } & {
        [key: string]: unknown;
    } | {
        associationType: "serviceIdOrKeys";
        values: string[];
    } & {
        [key: string]: unknown;
    } | {
        associationType: "commit" | "repository";
        values: ({
            commitHash: string;
            repositoryId: string;
        } & {
            [key: string]: unknown;
        } | {
            repositoryId: string;
        } & {
            [key: string]: unknown;
        })[];
    } & {
        [key: string]: unknown;
    })[];
    commands?: unknown[];
    deploymentSequenceNumber: number;
    description: string;
    displayName: string;
    duration?: number;
    environment: unknown;
    issueKeys?: string[];
    label?: string;
    lastUpdated: string;
    pipeline: unknown;
    schemaVersion?: "1.0";
    state:
        | "failed"
        | "pending"
        | "unknown"
        | "in_progress"
        | "successful"
        | "cancelled"
        | "rolled_back";
    updateSequenceNumber: number;
    url: string;
}

Hierarchy

  • Record<string, unknown>
    • DeploymentData

Properties

associations? commands? deploymentSequenceNumber description displayName duration? environment issueKeys? label? lastUpdated pipeline schemaVersion? state updateSequenceNumber url

Properties

Optionalassociations

associations?: ({
    associationType: "issueKeys" | "issueIdOrKeys";
    values: string[];
} & {
    [key: string]: unknown;
} | {
    associationType: "serviceIdOrKeys";
    values: string[];
} & {
    [key: string]: unknown;
} | {
    associationType: "commit" | "repository";
    values: ({
        commitHash: string;
        repositoryId: string;
    } & {
        [key: string]: unknown;
    } | {
        repositoryId: string;
    } & {
        [key: string]: unknown;
    })[];
} & {
    [key: string]: unknown;
})[]

The entities to associate the Deployment information with. It must contain at least one of IssueIdOrKeysAssociation or ServiceIdOrKeysAssociation.

Optionalcommands

commands?: unknown[]

Commands

A list of commands to be actioned for this Deployment

deploymentSequenceNumber

deploymentSequenceNumber: number

This is the identifier for the deployment. It must be unique for the specified pipeline and environment. It must be a monotonically increasing number, as this is used to sequence the deployments.

Example

100

description

description: string

A short description of the deployment

Example

The bits are being transferred

displayName

displayName: string

The human-readable name for the deployment. Will be shown in the UI.

Example

Deployment number 16 of Data Depot

Optionalduration

duration?: number

The duration of the deployment (in seconds).

Example

47

environment

environment: unknown

Environment

The environment that the deployment is present in.

OptionalissueKeys

issueKeys?: string[]

Deprecated. The Jira issue keys to associate the Deployment information with. Should replace this field with the "associations" field to associate Deployment information with issueKeys or other types of associations.

Deprecated

Deprecated

Optionallabel

label?: string

An (optional) additional label that may be displayed with deployment information. Can be used to display version information etc. for the deployment.

Example

Release 2018-01-20_08-47-bc2421a

lastUpdated

lastUpdated: string

The last-updated timestamp to present to the user as a summary of the state of the deployment.

Example

2018-01-20T23:27:25.000Z

pipeline

pipeline: unknown

Pipeline

This object models the Continuous Delivery (CD) Pipeline concept, an automated process (usually comprised of multiple stages)

for getting software from version control right through to the production environment.

OptionalschemaVersion

schemaVersion

The DeploymentData schema version used for this deployment data.

Placeholder to support potential schema changes in the future.

Example

1

state

state:
    | "failed"
    | "pending"
    | "unknown"
    | "in_progress"
    | "successful"
    | "cancelled"
    | "rolled_back"

The state of the deployment

Example

in_progress

updateSequenceNumber

updateSequenceNumber: number

A number used to apply an order to the updates to the deployment, as identified by the deploymentSequenceNumber, in the case of out-of-order receipt of update requests. It must be a monotonically increasing number. For example, epoch time could be one way to generate the updateSequenceNumber.

Example

1

url

url: string

A URL users can use to link to this deployment, in this environment.

Example

http://mydeployer.com/project1/1111-222-333/prod-east

Settings

Member Visibility

On This Page

Properties