From 64c1c1777574d5a19a76ce96cb84ead5cb2245b1 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?readme-action=20=F0=9F=93=96?= Date: Wed, 17 Jul 2024 18:24:15 +0000 Subject: [PATCH] chore: update README.md --- README.md | 31 ++++++++++++++++++++++++++++++- 1 file changed, 30 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 59905c89..b04ee224 100644 --- a/README.md +++ b/README.md @@ -73,6 +73,7 @@ The config should have the following structure: integrations: github: gitops: + opentofu-version: 1.7.3 terraform-version: 1.5.2 infracost-enabled: false artifact-storage: @@ -91,7 +92,35 @@ integrations: > [!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. +### Support OpenTofu +This action supports [OpenTofu](https://opentofu.org/). + +> [!IMPORTANT] +> **Please note!** OpenTofu supported by Atmos `>= 1.73.0`. +> For details [read](https://atmos.tools/core-concepts/projects/configuration/opentofu/) + +To enable OpenTofu add the following settings to `atmos.yaml` + * Set the `opentofu-version` in the `atmos.yaml` to the desired version + * Set `components.terraform.command` to `tofu` + +#### Example + +```yaml + +components: + terraform: + command: tofu + +... + +integrations: + github: + gitops: + opentofu-version: 1.7.3 + ... +``` + ### Workflow example ```yaml @@ -122,7 +151,7 @@ integrations: component: "foobar" stack: "plat-ue2-sandbox" atmos-config-path: ./rootfs/usr/local/etc/atmos/ - atmos-version: 1.63.0 + atmos-version: 1.81.0 ``` ### Migrating from `v1` to `v2`