Interface UploadParameters

interface UploadParameters {
    apiBaseUrl?: string;
    branch?: string;
    buildName?: string;
    commit?: string;
    files?: string[];
    ignore?: string[];
    mode?: "ci" | "monitoring";
    parallel?: false | {
        nonce: string;
        total: number;
    };
    prNumber?: number;
    referenceBranch?: string;
    referenceCommit?: string;
    root?: string;
    token?: string;
}

Properties

apiBaseUrl?: string

Base URL of Argos API (default to "https://api.argos-ci.com/v2/")

branch?: string

Git branch

buildName?: string

Name of the build used to trigger multiple Argos builds on one commit

commit?: string

Git commit

files?: string[]

Globs matching image file paths to upload

ignore?: string[]

Globs matching image file paths to ignore (default to "**/*.{png,jpg,jpeg}")

mode?: "ci" | "monitoring"

Mode of comparison applied

parallel?: false | {
    nonce: string;
    total: number;
}

Parallel test suite mode

Type declaration

  • nonce: string

    Unique build ID for this parallel build

  • total: number

    The number of parallel nodes being ran

prNumber?: number

Pull-request number

referenceBranch?: string

Branch used as baseline for screenshot comparison

referenceCommit?: string

Commit used as baseline for screenshot comparison

root?: string

Root directory to look for image to upload (default to current directory)

token?: string

Argos repository token