Type alias EnvPromotion

Type declaration

• lockEnvironment:function

  • lockEnvironment(): Promise<LockResponse>

  • Lock environment

    Returns Promise<LockResponse>

    a promise that resolves to a LockResponse object.

• promoteConfiguration:function

  • promoteConfiguration(config: PromotionRequestConfig): Promise<PromotionResponse>

  • Promote configuration

    Parameters

    • config: PromotionRequestConfig

      Promotion request config

    Returns Promise<PromotionResponse>

    a promise that resolves to a PromotionResponse object.

• readLastPromotionReport:function

  • readLastPromotionReport(): Promise<PromotionReport>

  • Read last promotion report

    Returns Promise<PromotionReport>

    a promise that resolves to a PromotionReport object

• readLockStatus:function

  • readLockStatus(): Promise<LockStatus>

  • Read lock status

    Returns Promise<LockStatus>

    a promise that resolves to a LockStatus object

• readPromotionReport:function

  • readPromotionReport(reportId: string): Promise<PromotionReport>

  • Read promotion report

    Parameters

    • reportId: string

      Promotion id

    Returns Promise<PromotionReport>

    a promise that resolves to a PromotionReport object

• readPromotionReports:function

  • readPromotionReports(): Promise<PromotionReportStub[]>

  • Read a list of promotion reports in date order.

    Returns Promise<PromotionReportStub[]>

    a promise that resolves to an array of PromotionReportStub objects

• readPromotionStatus:function

  • readPromotionStatus(): Promise<PromotionStatus>

  • Read promotion status

    Returns Promise<PromotionStatus>

    a promise that resolves to a PromotionStatus object

• rollbackPromotion:function

  • rollbackPromotion(config: RollbackConfig): Promise<RollbackResponse>

  • Rollback a promotion

    Parameters

    • config: RollbackConfig

      Rollback config

    Returns Promise<RollbackResponse>

    a promise that resolves to a RollbackResponse object.

• runProvisionalPromotionReport:function

  • runProvisionalPromotionReport(): Promise<PromotionReport>

  • 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

• runProvisionalRollbackReport:function

  • runProvisionalRollbackReport(): Promise<PromotionReport>

  • Run a provisional rollback report of changes when we rollback the configuration to the previous promotion.

    Returns Promise<PromotionReport>

    a promise that resolves to a PromotionReport object

• unlockEnvironment:function

  • unlockEnvironment(promotionId: string): Promise<LockResponse>

  • Unlock environment

    Parameters

    • promotionId: string

      Promotion id.

    Returns Promise<LockResponse>

    a promise that resolves to a LockResponse object