From ea619d7fcfbb218a7d2ba366ad63a8b709549abc Mon Sep 17 00:00:00 2001 From: AbstractionFactory <179820029+abstractionfactory@users.noreply.github.com> Date: Tue, 11 Feb 2025 13:57:18 +0100 Subject: [PATCH] Readme cleanup Signed-off-by: AbstractionFactory <179820029+abstractionfactory@users.noreply.github.com> --- CODE_OF_CONDUCT.md | 10 ---------- README.md | 21 ++++++--------------- 2 files changed, 6 insertions(+), 25 deletions(-) delete mode 100644 CODE_OF_CONDUCT.md diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md deleted file mode 100644 index 0091725..0000000 --- a/CODE_OF_CONDUCT.md +++ /dev/null @@ -1,10 +0,0 @@ -# Code of Conduct - -We follow the [CNCF Code of Conduct](https://github.com/cncf/foundation/blob/main/code-of-conduct.md). - - -Please contact contact@opentf.org in order to report violations of the Code of Conduct. diff --git a/README.md b/README.md index c6dbd4e..7b896fc 100644 --- a/README.md +++ b/README.md @@ -1,18 +1,12 @@ -# setup-opentofu +# GitHub Action for setting up OpenTofu -The `opentofu/setup-opentofu` action sets up OpenTofu CLI in your GitHub Actions workflow by: +> [!NOTE] +> This is a community-maintained repository. The OpenTofu team does not fix bugs or add features, but is happy to review community pull requests. -- Downloading the latest version of OpenTofu CLI and adding it to the `PATH`. -- Configuring the [CLI configuration file](https://opentofu.org/docs/cli/config/config-file/) with a Terraform Cloud/Enterprise hostname and API token. -- Installing a wrapper script to wrap subsequent calls of the `tofu` binary and expose its STDOUT, STDERR, and exit code as outputs named `stdout`, `stderr`, and `exitcode` respectively. (This can be optionally skipped if subsequent steps in the same job do not need to access the results of - OpenTofu commands.) +> [!TIP] +> Having trouble with exit codes or the output format? Try setting the `tofu_wrapper` setting to `false`. -After you've used the action, subsequent steps in the same job can run arbitrary OpenTofu commands using [the GitHub Actions `run` syntax](https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idstepsrun). This allows most OpenTofu commands to work exactly -like they do on your local command line. - -## Experimental Status - -By using the software in this repository (the "Software"), you acknowledge that: (1) the Software is still in development, may change, and has not been released as a commercial product by OpenTofu; (2) the Software is provided on an "as-is" basis, and may include bugs, errors, or other issues; (3) the Software is NOT INTENDED FOR PRODUCTION USE, use of the Software may result in unexpected results, loss of data, or other unexpected results, and OpenTofu disclaims any and all liability resulting from use of the Software. +The `opentofu/setup-opentofu` action sets up OpenTofu CLI in GitHub Actions. ## Usage @@ -272,6 +266,3 @@ to `true`, the following outputs are available for subsequent steps that call th [Mozilla Public License v2.0](LICENSE) -## Code of Conduct - -[Code of Conduct](CODE_OF_CONDUCT.md)