Interface SubmitDeployments

interface SubmitDeployments {
    deployments?: {
        associations: any[];
        commands?: {
            command?: string;
        }[];
        deploymentSequenceNumber: number;
        description: string;
        displayName: string;
        environment: {
            displayName: string;
            id: string;
            type: string;
        };
        label?: string;
        lastUpdated: string;
        pipeline: {
            displayName: string;
            id: string;
            url: string;
        };
        schemaVersion?: string;
        state: string;
        triggeredBy?: {
            email?: string;
        };
        updateSequenceNumber: number;
        url: string;
    }[];
    properties?: {};
    providerMetadata?: {
        product?: string;
    };
}

Properties

deployments? properties? providerMetadata?

Properties

Optional deployments

deployments?: {
    associations: any[];
    commands?: {
        command?: string;
    }[];
    deploymentSequenceNumber: number;
    description: string;
    displayName: string;
    environment: {
        displayName: string;
        id: string;
        type: string;
    };
    label?: string;
    lastUpdated: string;
    pipeline: {
        displayName: string;
        id: string;
        url: string;
    };
    schemaVersion?: string;
    state: string;
    triggeredBy?: {
        email?: string;
    };
    updateSequenceNumber: number;
    url: string;
}[]

A list of deployments to submit to Jira.

Each deployment may be associated with one or more Jira issue keys, and will be associated with any properties included in this request.

Type declaration

  • associations: any[]

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

  • Optional commands?: {
        command?: string;
    }[]

    A list of commands to be actioned for this Deployment

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

  • description: string

    A short description of the deployment

  • displayName: string

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

  • environment: {
        displayName: string;
        id: string;
        type: string;
    }

    The environment that the deployment is present in.

    • displayName: string

      The name of the environment to present to the user.

    • id: string

      The identifier of this environment, must be unique for the provider so that it can be shared across pipelines.

    • type: string

      The type of the environment.

  • Optional label?: string

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

  • lastUpdated: string

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

  • pipeline: {
        displayName: string;
        id: string;
        url: string;
    }

    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.

    • displayName: string

      The name of the pipeline to present to the user.

    • id: string

      The identifier of this pipeline, must be unique for the provider.

    • url: string

      A URL users can use to link to this deployment pipeline.

  • Optional schemaVersion?: string

    The DeploymentData schema version used for this deployment data.

    Placeholder to support potential schema changes in the future.

  • state: string

    The state of the deployment

  • Optional triggeredBy?: {
        email?: string;
    }

    Describes the user who triggered the deployment

    • Optional email?: string

      The email address of the user. Used to associate the user with a Jira user. Max length is 255 characters.

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

  • url: string

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

Optional properties

properties?: {}

Properties assigned to deployment data that can then be used for delete / query operations.

Examples might be an account or user ID that can then be used to clean up data if an account is removed from the Provider system.

Properties are supplied as key/value pairs, and a maximum of 5 properties can be supplied, keys cannot contain ':' or start with '_'.

Type declaration

    Optional providerMetadata

    providerMetadata?: {
        product?: string;
    }

    Information about the provider. This is useful for auditing, logging, debugging, and other internal uses. It is not considered private information. Hence, it may not contain personally identifiable information.

    Type declaration

    • Optional product?: string

      An optional name of the source of the deployments data.

    Settings

    Member Visibility

    Theme

    On This Page

    deploymentspropertiesproviderMetadata