Interface SubmitBuilds

interface SubmitBuilds {
    builds?: {
        buildNumber: number;
        description?: string;
        displayName: string;
        issueKeys: string[];
        label?: string;
        lastUpdated: string;
        pipelineId: string;
        references?: {
            commit?: {
                id: string;
                repositoryUri: string;
            };
            ref?: {
                name: string;
                uri: string;
            };
        }[];
        schemaVersion?: string;
        state: string;
        testInfo?: {
            numberFailed: number;
            numberPassed: number;
            numberSkipped?: number;
            totalNumber: number;
        };
        updateSequenceNumber: number;
        url: string;
    }[];
    properties?: {};
    providerMetadata?: {
        product?: string;
    };
}

Properties

builds? properties? providerMetadata?

Properties

Optional builds

builds?: {
    buildNumber: number;
    description?: string;
    displayName: string;
    issueKeys: string[];
    label?: string;
    lastUpdated: string;
    pipelineId: string;
    references?: {
        commit?: {
            id: string;
            repositoryUri: string;
        };
        ref?: {
            name: string;
            uri: string;
        };
    }[];
    schemaVersion?: string;
    state: string;
    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.

Type declaration

  • buildNumber: number

    Identifies a build within the sequence of builds identified by the build pipelineId.

    Used to identify the 'most recent' build in that sequence of builds.

    The combination of pipelineId and buildNumber must uniquely identify a build you have provided.

  • Optional description?: string

    An optional description to attach to this build.

    This may be anything that makes sense in your system.

  • displayName: string

    The human-readable name for the build.

    Will be shown in the UI.

  • issueKeys: string[]

    The Jira issue keys to associate the build information with.

    You are free to associate issue keys in any way you like. However, we recommend that you use the name of the branch the build was executed on, and extract issue keys from that name using a simple regex. This has the advantage that it provides an intuitive association of builds to issue keys.

  • Optional label?: string

    A human-readable string that to provide information about the build.

  • lastUpdated: string

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

  • pipelineId: string

    An ID that relates a sequence of builds. Depending on your use case this might be a project ID, pipeline ID, plan key etc. - whatever logical unit you use to group a sequence of builds.

    The combination of pipelineId and buildNumber must uniquely identify a build you have provided.

  • Optional references?: {
        commit?: {
            id: string;
            repositoryUri: string;
        };
        ref?: {
            name: string;
            uri: string;
        };
    }[]

    Optional information that links a build to a commit, branch etc.

  • Optional schemaVersion?: string

    The schema version used for this data.

    Placeholder to support potential schema changes in the future.

  • state: string

    The state of a build.

    pending - The build is queued, or some manual action is required. in_progress - The build is currently running. successful - The build completed successfully. failed - The build failed. cancelled - The build has been cancelled or stopped. unknown - The build is in an unknown state.

  • Optional testInfo?: {
        numberFailed: number;
        numberPassed: number;
        numberSkipped?: number;
        totalNumber: number;
    }

    Information about tests that were executed during a build.

    • numberFailed: number

      The number of tests that failed during a build.

    • numberPassed: number

      The number of tests that passed during a build.

    • Optional numberSkipped?: number

      The number of tests that were skipped during a build.

    • totalNumber: number

      The total number of tests considered during a build.

  • updateSequenceNumber: number

    A number used to apply an order to the updates to the build, as identified by pipelineId and buildNumber, 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.

    Updates for a build that is received with an updateSqeuenceNumber less than or equal to what is currently stored will be ignored.

  • url: string

    The URL to this build in your system.

Optional properties

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

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 builds data.

    Settings

    Member Visibility

    Theme

    On This Page

    buildspropertiesproviderMetadata