Skip to main content

CommitModeCompletedEvent

This event is emitted when commit has recorded a terraform apply back into octo state.

@group

Events/ModeResult

Hierarchy

  • ModeResultEvent<{ emptiedModuleIds: string[]; resources: { action: AggregatedResourceAction[action]; moduleId?: string; previousTerraformAddresses: string[]; reason?: string; resourceContext: string; resourceId: string; terraformAddresses: string[] }[]; responses: { key: string; previousValue?: string; resourceContext: string; value: string }[]; warnings: { message: string; moduleId?: string }[] }>
    • CommitModeCompletedEvent

Index

Constructors

Properties

Constructors

constructor

  • CommitModeCompletedEvent(name?: string, payload?: { emptiedModuleIds: string[]; resources: { action: ADD | DELETE | REPLACE | UPDATE; moduleId?: string; previousTerraformAddresses: string[]; reason?: string; resourceContext: string; resourceId: string; terraformAddresses: string[] }[]; responses: { key: string; previousValue?: string; resourceContext: string; value: string }[]; warnings: { message: string; moduleId?: string }[] }): CommitModeCompletedEvent

  • Parameters

    • optionalname: string

      The subject of the event, when the event type alone does not identify it.

    • optionalpayload: { emptiedModuleIds: string[]; resources: { action: ADD | DELETE | REPLACE | UPDATE; moduleId?: string; previousTerraformAddresses: string[]; reason?: string; resourceContext: string; resourceId: string; terraformAddresses: string[] }[]; responses: { key: string; previousValue?: string; resourceContext: string; value: string }[]; warnings: { message: string; moduleId?: string }[] }

      The event's data.

      • emptiedModuleIds: string[]

        Modules whose folders were written without resources, because they left intent.

      • resources: { action: ADD | DELETE | REPLACE | UPDATE; moduleId?: string; previousTerraformAddresses: string[]; reason?: string; resourceContext: string; resourceId: string; terraformAddresses: string[] }[]

        Each octo resource this commit applied, with the terraform addresses it renders now and the ones the last commit recorded for it. Carries no terraform actions - commit runs after the apply, so it has no plan to read.

      • responses: { key: string; previousValue?: string; resourceContext: string; value: string }[]

        Every response key written onto a resource from a terraform output, with the value it replaced.

      • warnings: { message: string; moduleId?: string }[]

    Returns CommitModeCompletedEvent

Properties

readonlyinheritedheader

header: { sequence: number; timestamp: number }

When the event was created. sequence counts every event this process created, so it orders two events created in the same millisecond, and events a late listener receives replayed.

Type declaration

  • sequence: number
  • timestamp: number

readonlyinheritedname

name: string

The subject of the event, when the event type alone does not identify it - e.g. the class name on a registration event. Empty otherwise.

readonlyinheritedpayload

payload: { emptiedModuleIds: string[]; resources: { action: ADD | DELETE | REPLACE | UPDATE; moduleId?: string; previousTerraformAddresses: string[]; reason?: string; resourceContext: string; resourceId: string; terraformAddresses: string[] }[]; responses: { key: string; previousValue?: string; resourceContext: string; value: string }[]; warnings: { message: string; moduleId?: string }[] }

The event's data. Its shape is fixed by the event type.

Type declaration

  • emptiedModuleIds: string[]

    Modules whose folders were written without resources, because they left intent.

  • resources: { action: ADD | DELETE | REPLACE | UPDATE; moduleId?: string; previousTerraformAddresses: string[]; reason?: string; resourceContext: string; resourceId: string; terraformAddresses: string[] }[]

    Each octo resource this commit applied, with the terraform addresses it renders now and the ones the last commit recorded for it. Carries no terraform actions - commit runs after the apply, so it has no plan to read.

  • responses: { key: string; previousValue?: string; resourceContext: string; value: string }[]

    Every response key written onto a resource from a terraform output, with the value it replaced.

  • warnings: { message: string; moduleId?: string }[]
Page Options