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

x/jira/src/agile/parameters/submitBuilds.ts>SubmitBuilds

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

Properties

optional
properties: { }

Properties assigned to build 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.

Note that these properties will never be returned with build data. They are not intended for use as metadata to associate with a build. Internally they are stored as a hash so that personal information etc. is never stored within Jira.

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

optional
builds: { schemaVersion?: "1.0" | string; pipelineId: string; buildNumber: number; updateSequenceNumber: number; displayName: string; description?: string; label?: string; url: string; state:
| "pending"
| "in_progress"
| "successful"
| "failed"
| "cancelled"
| "unknown"
| string
; lastUpdated: string; issueKeys: string[]; testInfo?: { totalNumber: number; numberPassed: number; numberFailed: number; numberSkipped?: number; }; references?: { commit?: { id: string; repositoryUri: string; }; ref?: { name: string; uri: string; }; }[]; }[]

A list of builds to submit to Jira.

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

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