diff --git a/README.yaml b/README.yaml index 18967b0..3087aa0 100644 --- a/README.yaml +++ b/README.yaml @@ -62,7 +62,9 @@ usage: |- ### Config > [!IMPORTANT] - > **Please note!** This GitHub Action only works with `atmos >= 1.63.0`. If you are using `atmos < 1.63.0` please use `v1` version of this action. + > **Please note!** This GitHub Action only works with `atmos >= 1.99.0`. + > If you are using `atmos >= 1.63.0, < 1.99.0` please use `v2` version of this action. + > If you are using `atmos < 1.63.0` please use `v1` version of this action. The action expects the atmos configuration file `atmos.yaml` to be present in the repository. @@ -120,6 +122,32 @@ usage: |- group-by: .stack_slug | split("-") | [.[0], .[2]] | join("-") ``` + ### Stack level configuration + + > [!IMPORTANT] + > Wherever it is possible to specify `integration.github.gitops` on stack level + > it is required to define default values in `atmos.yaml` + + It is possible to override integration settings on a stack level by defining `settings.integrations`. + + ```yaml + components: + terraform: + foobar: + settings: + integrations: + github: + gitops: + artifact-storage: + bucket: cptest-plat-ue2-auto-gitops + table: cptest-plat-ue2-auto-gitops-plan-storage + role: arn:aws:iam::xxxxxxxxxxxx:role/cptest-plat-ue2-auto-gitops-gha + role: + # Set `plan` empty if you don't want to assume IAM role before terraform plan + plan: arn:aws:iam::yyyyyyyyyyyy:role/cptest-plat-gbl-identity-gitops + apply: arn:aws:iam::yyyyyyyyyyyy:role/cptest-plat-gbl-identity-gitops + ``` + ### Support OpenTofu This action supports [OpenTofu](https://opentofu.org/). @@ -184,6 +212,17 @@ usage: |- atmos-config-path: ./rootfs/usr/local/etc/atmos/ ``` + ### Migrating from `v2` to `v3` + + The notable changes in `v3` are: + + - `v3` works only with `atmos >= 1.99.0` + - `v3` support azure plan and metadata storage + - `v3` supports stack level integration gitops settings + - `v3` allow to skip internal checkout with `skip-checkout` input + + The only required migration step is updating atmos version to `>= 1.99.0` + ### Migrating from `v1` to `v2` The notable changes in `v2` are: