jira.js
    Preparing search index...

    Function submitBuilds

    • Update / insert builds data.

      Builds are identified by the combination of pipelineId and buildNumber, and existing build data for the same build will be replaced if it exists and the updateSequenceNumber of the existing data is less than the incoming data.

      Submissions are performed asynchronously. Submitted data will eventually be available in Jira; most updates are available within a short period of time, but may take some time during peak load and/or maintenance times. The getBuildByKey operation can be used to confirm that data has been stored successfully (if needed).

      In the case of multiple builds being submitted in one request, each is validated individually prior to submission. Details of which build failed submission (if any) are available in the response object.

      Parameters

      • client: Client
      • parameters: {
            builds: {
                associations?: {
                    associationType: string & {} | "issueKeys" | "issueIdOrKeys";
                    values: string[];
                    [key: string]: unknown;
                }[];
                buildNumber: number;
                description?: string;
                displayName: string;
                label?: string;
                lastUpdated: string
                | Date;
                pipelineId: string;
                references?: {
                    commit?: { id: string; repositoryUri: string };
                    ref?: { name: string; uri: string };
                }[];
                schemaVersion?: string & {}
                | "1.0";
                state:
                    | "failed"
                    | "unknown"
                    | "pending"
                    | string & {}
                    | "successful"
                    | "in_progress"
                    | "cancelled";
                testInfo?: {
                    numberFailed: number;
                    numberPassed: number;
                    numberSkipped?: number;
                    totalNumber: number;
                };
                updateSequenceNumber: number;
                url: string;
            }[];
            properties?: Record<string, any>;
            providerMetadata?: { product?: string };
        }
        • builds: {
              associations?: {
                  associationType: string & {} | "issueKeys" | "issueIdOrKeys";
                  values: string[];
                  [key: string]: unknown;
              }[];
              buildNumber: number;
              description?: string;
              displayName: string;
              label?: string;
              lastUpdated: string
              | Date;
              pipelineId: string;
              references?: {
                  commit?: { id: string; repositoryUri: string };
                  ref?: { name: string; uri: string };
              }[];
              schemaVersion?: string & {}
              | "1.0";
              state:
                  | "failed"
                  | "unknown"
                  | "pending"
                  | string & {}
                  | "successful"
                  | "in_progress"
                  | "cancelled";
              testInfo?: {
                  numberFailed: number;
                  numberPassed: number;
                  numberSkipped?: number;
                  totalNumber: number;
              };
              updateSequenceNumber: number;
              url: 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.

        • Optionalproperties?: Record<string, any>

          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 '_'.

        • OptionalproviderMetadata?: { 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.

          • Optionalproduct?: string

            An optional name of the source of the builds data.

      • Optionaloptions: RequestOptions

      Returns Promise<
          {
              acceptedBuilds?: {
                  buildNumber: number;
                  pipelineId: string;
                  [key: string]: unknown;
              }[];
              rejectedBuilds?: {
                  errors: {
                      errorTraceId?: string;
                      message: string;
                      [key: string]: unknown;
                  }[];
                  key: { buildNumber: number; pipelineId: string; [key: string]: unknown };
                  [key: string]: unknown;
              }[];
              unknownAssociations?: {
                  associationType: string & {}
                  | "issueKeys"
                  | "issueIdOrKeys";
                  values: string[];
                  [key: string]: unknown;
              }[];
              unknownIssueKeys?: string[];
              [key: string]: unknown;
          },
      >

    Settings
    Member Visibility