Skip to content
Open
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 11 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -190,6 +190,17 @@ integrations:
...
```

### Plan Diff mode

The action provides a `plan-diff` mode that compares the newly generated plan against the previously stored plan and fails the workflow if any differences are detected.

To enable plan diff mode, set the `plan-diff` input to `true`.

> [!IMPORTANT]
> When plan-diff is disabled, the action will apply the stored plan without re-validating it.
> This may result in unintended changes if the underlying infrastructure has been modified between the plan and apply steps.
> Additionally, stored plans are single-use: even if an apply operation fails for any reason, the plan becomes outdated and cannot be reused.

### Workflow example

In this example, the action is triggered when certain events occur, such as a manual workflow dispatch or the opening, synchronization, or reopening of a pull request, specifically on the main branch. It specifies specific permissions related to assuming roles in AWS. Within the "apply" job, the "component" and "stack" are hardcoded (`foobar` and `plat-ue2-sandbox`). In practice, these are usually derived from another action.
Expand Down
6 changes: 3 additions & 3 deletions README.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -189,9 +189,9 @@ usage: |-
To enable plan diff mode, set the `plan-diff` input to `true`.

> [!IMPORTANT]
> When plan-diff is disabled, the action will apply the stored plan without re-validating it.
> This may result in unintended changes if the underlying infrastructure has been modified between the plan and apply steps.
> Additionally, stored plans are single-use: even if an apply operation fails for any reason, the plan becomes outdated and cannot be reused.
> When plan-diff is disabled, the action will apply the stored plan without re-validating it.
> This may result in unintended changes if the underlying infrastructure has been modified between the plan and apply steps.
> Additionally, stored plans are single-use: even if an apply operation fails for any reason, the plan becomes outdated and cannot be reused.

### Workflow example

Expand Down
Loading