actions/setup-opentofu
1
0
Fork 0
mirror of https://github.com/opentofu/setup-opentofu.git synced 2025-12-06 07:50:37 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

Readme cleanup (#48)

Browse source 
* Readme cleanup

Signed-off-by: AbstractionFactory <179820029+abstractionfactory@users.noreply.github.com>

* Update README.md

Co-authored-by: Oleksandr Levchenkov <ollevche@gmail.com>
Signed-off-by: AbstractionFactory <179820029+abstractionfactory@users.noreply.github.com>

---------

Signed-off-by: AbstractionFactory <179820029+abstractionfactory@users.noreply.github.com>
Co-authored-by: Oleksandr Levchenkov <ollevche@gmail.com>
This commit is contained in:
AbstractionFactory 2025-02-11 18:20:29 +01:00 • committed by GitHub
parent 592200bd4b
commit 4a98c1282d
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
2 changed files with 6 additions and 25 deletions
Download patch file Download diff file Expand all files Collapse all files

10
CODE_OF_CONDUCT.md
View file

@ -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).
<!-- TODO: Decide who will handle Code of Conduct reports and replace [INSERT EMAIL ADDRESS]
with an email address in the paragraph below. We recommend using a mailing list to handle reports.
If your project isn't prepared to handle reports, remove the project email address and just have
reporters send to conduct@cncf.io.
-->
Please contact contact@opentf.org in order to report violations of the Code of Conduct.

21
README.md
View file

@ -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 non-critical 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)