setup-opentofu
A GitHub Action to install and configure the OpenTofu CLI for infrastructure-as-code workflows.
What is setup-opentofu?
opentofu/setup-opentofu is a GitHub Action that installs and configures the OpenTofu CLI in GitHub Actions workflows. It solves the problem of manually setting up OpenTofu for infrastructure-as-code automation by providing a reusable, configurable step that handles version installation, credential setup, and output management.
DevOps engineers and developers who use GitHub Actions for CI/CD and need to run OpenTofu commands for infrastructure provisioning and management as part of their automated pipelines.
Developers choose this action because it offers a streamlined, official-feeling setup for OpenTofu within GitHub Actions, with features like version flexibility, credential integration, and output wrapping that enhance workflow automation and reliability.
Overview
The opentofu/setup-opentofu action is a tool for GitHub Actions that automates the setup of the OpenTofu CLI. It enables developers to seamlessly integrate infrastructure-as-code practices into their CI/CD pipelines by providing the necessary command-line tools directly in their workflow runners.
Key Features
- Version Management — Installs a specific version of OpenTofu CLI or reads it from a version file, supporting semantic versioning ranges and pre-release versions.
- Wrapper Script — Optionally wraps the
tofubinary to expose its STDOUT, STDERR, and exit code as outputs for subsequent steps. - Credential Configuration — Configures credentials for Terraform Cloud or Terraform Enterprise instances directly from GitHub Secrets.
- Binary Caching — Supports caching of the OpenTofu binary to reduce download times on subsequent runs, particularly beneficial for self-hosted runners.
- Multi-Platform Support — Runs on Ubuntu, Windows, and macOS GitHub Actions runners, with Bash shell support on Windows.
Philosophy
The action is designed to be a reliable, community-maintained utility that simplifies OpenTofu integration in automated workflows, emphasizing flexibility through configurable inputs and outputs.
Related Projects
Found a gem we're missing?
Open-Awesome is built by the community, for the community. Submit a project, suggest an awesome list, or help improve the catalog on GitHub.
