Frodo Library - v5.0.0-47
    Preparing search index...

    Type Alias EnvPromotion

    type EnvPromotion = {
        lockEnvironment(
            wait?: boolean,
            pollInterval?: number,
            timeout?: number,
        ): Promise<LockStatus>;
        promoteConfiguration(
            config: PromotionRequestConfig,
            wait?: boolean,
            pollInterval?: number,
            timeout?: number,
        ): Promise<PromotionResponse>;
        readLastPromotionReport(): Promise<PromotionReport>;
        readLockStatus(localLockOnly?: boolean): Promise<LockStatus>;
        readPromotionReport(reportId: string): Promise<PromotionReport>;
        readPromotionReports(): Promise<PromotionReportStub[]>;
        readPromotionStatus(): Promise<PromotionStatusResponse>;
        rollbackPromotion(
            config: RollbackConfig,
            wait?: boolean,
            pollInterval?: number,
            timeout?: number,
        ): Promise<RollbackResponse>;
        runProvisionalPromotionReport(): Promise<PromotionReport>;
        runProvisionalRollbackReport(): Promise<PromotionReport>;
        unlockEnvironment(
            promotionId?: string,
            wait?: boolean,
            pollInterval?: number,
            timeout?: number,
        ): Promise<LockStatus>;
    }
    Index
    • Lock environment

      Parameters

      • Optionalwait: boolean

        Whether to wait for the environment to lock. Default: false

      • OptionalpollInterval: number

        Time between status checks in milliseconds. Default: 10000

      • Optionaltimeout: number

        Timeout in milliseconds. Default: 15 * 60 * 1000

      Returns Promise<LockStatus>

      a promise that resolves to a LockStatus object.

    • Promote configuration

      Parameters

      • config: PromotionRequestConfig

        Promotion request config.

      • Optionalwait: boolean

        Whether to wait for the promotion to complete. Default: false

      • OptionalpollInterval: number

        Time between status checks in milliseconds. Default: 10000

      • Optionaltimeout: number

        Timeout in milliseconds. Default: 45 * 60 * 1000

      Returns Promise<PromotionResponse>

      a promise that resolves to a PromotionResponse object.

    • Read lock status

      Parameters

      • OptionallocalLockOnly: boolean

        True to show lock status of current environment. Default: false

      Returns Promise<LockStatus>

      a promise that resolves to a LockStatus object

    • Rollback a promotion

      Parameters

      • config: RollbackConfig

        Rollback config.

      • Optionalwait: boolean

        Whether to wait for the rollback to complete. Default: false

      • OptionalpollInterval: number

        Time between status checks in milliseconds. Default: 10000

      • Optionaltimeout: number

        Timeout in milliseconds. Default: 45 * 60 * 1000

      Returns Promise<RollbackResponse>

      a promise that resolves to a RollbackResponse object.

    • Run a provisional report of changes since the last time the lower environment was promoted to the upper environment. The report generated is for informational purposes only and may not reflect all the changes in a full promotion. A dry-run promotion is always recommended prior to a full promotion between environments.

      Returns Promise<PromotionReport>

      a promise that resolves to a PromotionReport object

    • Unlock environment

      Parameters

      • OptionalpromotionId: string

        Optional promotion id. If not specified, will pull it from the environment lock status

      • Optionalwait: boolean

        Whether to wait for the environment to unlock. Default: false

      • OptionalpollInterval: number

        Time between status checks in milliseconds. Default: 10000

      • Optionaltimeout: number

        Timeout in milliseconds. Default: 15 * 60 * 1000

      Returns Promise<LockStatus>

      a promise that resolves to a LockStatus object.