Skip to main content
The Deno 2 Release Candidate is here
Learn more
Module

x/jira/src/agile/models/submitDeployments.ts>SubmitDeployments

A JavaScript/TypeScript wrapper for the JIRA Cloud, Service Desk and Agile REST API
MrRefactoring/jira.js
Latest
interface SubmitDeployments
import { type SubmitDeployments } from "https://deno.land/x/jira@v3.0.2/src/agile/models/submitDeployments.ts";

The result of a successful submitDeployments request.*

Properties

optional
acceptedDeployments: { pipelineId: string; environmentId: string; deploymentSequenceNumber: number; }[]

The keys of deployments that have been accepted for submission. A deployment key is a composite key that consists of pipelineId, environmentId and deploymentSequenceNumber.

A deployment may be rejected if it was only associated with unknown issue keys.

Note that a deployment that isn't updated due to it's updateSequenceNumber being out of order is not considered a failed submission.

optional
rejectedDeployments: { key: { pipelineId: string; environmentId: string; deploymentSequenceNumber: number; }; errors: { message: string; errorTraceId?: string; }[]; }[]

Details of deployments that have not been accepted for submission, usually due to a problem with the request data.

The object will contain the deployment key and any errors associated with that deployment that have prevented it being submitted.

optional
unknownIssueKeys: string[]

Issue keys that are not known on this Jira instance (if any).

These may be invalid keys (e.g. UTF-8 is sometimes incorrectly identified as a Jira issue key), or they may be for projects that no longer exist.

If a deployment has been associated with issue keys other than those in this array it will still be stored against those valid keys. If a deployment was only associated with issue keys deemed to be invalid it won't be persisted.

optional
unknownAssociations: { }[]

Associations (e.g. Issue Keys or Service IDs) that are not known on this Jira instance (if any).

These may be invalid keys (e.g. UTF-8 is sometimes incorrectly identified as a Jira issue key), or they may be for projects that no longer exist.

If a deployment has been associated with any other association other than those in this array it will still be stored against those valid associations. If a deployment was only associated with the associations in this array, it is deemed to be invalid and it won't be persisted.