@argos-ci/core
    Preparing search index...

    Interface DeployParameters

    interface DeployParameters {
        apiBaseUrl?: string;
        branch?: string;
        commit?: string;
        environment?: "preview" | "production";
        prNumber?: number;
        root: string;
        token?: string;
    }
    Index

    Properties

    apiBaseUrl?: string

    Base URL of the Argos API.

    "https://api.argos-ci.com/v2/"
    
    branch?: string

    Git branch name of the deployment.

    commit?: string

    Git commit SHA of the deployment.

    environment?: "preview" | "production"

    Deployment environment.

    "preview"
    
    prNumber?: number

    Pull request number associated with the deployment.

    root: string

    Directory containing the static files to deploy.

    token?: string

    Argos repository access token.