Skip to content

Commit 99b9b1e

Browse files
committed
chore: update README.md
1 parent 267eec5 commit 99b9b1e

File tree

1 file changed

+10
-2
lines changed

1 file changed

+10
-2
lines changed

README.md

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -73,7 +73,8 @@ this action. For more on setting up those components, see the [`gitops` componen
7373
### Config
7474

7575
> [!IMPORTANT]
76-
> **Please note!** This GitHub Action only works with `atmos >= 1.158.0`.
76+
> **Please note!** This GitHub Action only works with `atmos >= 1.186.0`.
77+
> If you are using `atmos >= 1.158.0, < 1.186.0` please use `v4` version of this action.
7778
> If you are using `atmos >= 1.99.0, < 1.158.0` please use `v3` version of this action.
7879
> If you are using `atmos >= 1.63.0, < 1.99.0` please use `v2` version of this action.
7980
> If you are using `atmos < 1.63.0` please use `v1` version of this action.
@@ -217,12 +218,19 @@ We recommend combining this action with the [`affected-stacks`](https://atmos.to
217218
runs-on: ubuntu-latest
218219
steps:
219220
- name: Terraform Apply
220-
uses: cloudposse/github-action-atmos-terraform-apply@v2
221+
uses: cloudposse/github-action-atmos-terraform-apply@v5
221222
with:
222223
component: "foobar"
223224
stack: "plat-ue2-sandbox"
224225
atmos-config-path: ./rootfs/usr/local/etc/atmos/
225226
```
227+
### Migrating from `v4` to `v5`
228+
229+
The notable changes in `v5` are:
230+
231+
- `v5` works only with `atmos >= 1.186.0`
232+
- `v5` uses `atmos terraform plan-diff` to ensure changes to be applied are consistent with the stored (approved by the user) planfile.
233+
226234
### Migrating from `v3` to `v4`
227235

228236
The notable changes in `v4` are:

0 commit comments

Comments
 (0)