Skip to content

Commit f08a7b8

Browse files
committed
chore: update README.md
1 parent ca49b1e commit f08a7b8

File tree

1 file changed

+10
-3
lines changed

1 file changed

+10
-3
lines changed

README.md

Lines changed: 10 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -67,7 +67,8 @@ this action. For more on setting up those components, see the `gitops` component
6767
### Config
6868

6969
> [!IMPORTANT]
70-
> **Please note!** This GitHub Action only works with `atmos >= 1.99.0`.
70+
> **Please note!** This GitHub Action only works with `atmos >= v1.158.0`
71+
> If you are using `atmos >= 1.99.0, < 1.158.0` please use `v4` version of this action.
7172
> If you are using `atmos >= 1.63.0, < 1.99.0` please use `v2` or `v3` version of this action.
7273
> If you are using `atmos < 1.63.0` please use `v1` version of this action.
7374
@@ -214,9 +215,15 @@ integrations:
214215
component: "foobar"
215216
stack: "plat-ue2-sandbox"
216217
atmos-config-path: ./rootfs/usr/local/etc/atmos/
217-
atmos-version: 1.81.0
218+
atmos-version: 1.158.0
218219
```
219220

221+
### Migrating from `v4` to `v5`
222+
223+
The notable changes in `v5` are:
224+
- `v5` works only with `atmos >= 1.158.0`
225+
- `v5` supports atnos `templates` and `functions`
226+
220227
### Migrating from `v3` to `v4`
221228

222229
The notable changes in `v4` are:
@@ -401,7 +408,7 @@ Which would produce the same behavior as in `v1`, doing this:
401408
| Name | Description | Default | Required |
402409
|------|-------------|---------|----------|
403410
| atmos-config-path | The path to the atmos.yaml file | N/A | true |
404-
| atmos-version | The version of atmos to install | >= 1.99.0 | false |
411+
| atmos-version | The version of atmos to install | >= 1.158.0 | false |
405412
| branding-logo-image | Branding logo image url | https://cloudposse.com/logo-300x69.svg | false |
406413
| branding-logo-url | Branding logo url | https://cloudposse.com/ | false |
407414
| component | The name of the component to plan. | N/A | true |

0 commit comments

Comments
 (0)