Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/dflook/terraform-version
GitHub action to determine terraform version for a configuration
https://github.com/dflook/terraform-version
actions devops github-action github-actions terraform
Last synced: about 1 month ago
JSON representation
GitHub action to determine terraform version for a configuration
- Host: GitHub
- URL: https://github.com/dflook/terraform-version
- Owner: dflook
- Created: 2020-07-05T14:25:21.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2024-05-28T19:56:34.000Z (7 months ago)
- Last Synced: 2024-05-29T10:47:53.285Z (7 months ago)
- Topics: actions, devops, github-action, github-actions, terraform
- Homepage:
- Size: 41 KB
- Stars: 6
- Watchers: 3
- Forks: 4
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
Awesome Lists containing this project
README
# terraform-version action
This is one of a suite of Terraform related actions - find them at [dflook/terraform-github-actions](https://github.com/dflook/terraform-github-actions).
This action determines the Terraform and provider versions to use for the root module.
The best way to specify the version is using a [`required_version`](https://www.terraform.io/docs/configuration/terraform.html#specifying-a-required-terraform-version) constraint.
The version to use is discovered from the first of:
1. The version set in the cloud workspace if the module uses a `remote` backend or `cloud` configuration, and the remote workspace exists.
2. A [`required_version`](https://www.terraform.io/docs/configuration/terraform.html#specifying-a-required-terraform-version)
constraint in the Terraform configuration. If the constraint is range, the latest matching version is used.
3. A [tfswitch](https://warrensbox.github.io/terraform-switcher/) `.tfswitchrc` file in the module path
4. A [tfenv](https://github.com/tfutils/tfenv) `.terraform-version` file in the module path
5. An [asdf](https://asdf-vm.com/) `.tool-versions` file in the module path or any parent path
6. An `OPENTOFU_VERSION` environment variable containing a [version constraint](https://www.terraform.io/language/expressions/version-constraints). If the constraint allows multiple versions, the latest matching version is used.
7. A `TERRAFORM_VERSION` environment variable containing a [version constraint](https://www.terraform.io/language/expressions/version-constraints). If the constraint allows multiple versions, the latest matching version is used.
8. The Terraform version that created the current state file (best effort).
9. The latest Terraform version
The version of Terraform and all required providers will be output to the workflow log.
Other terraform actions automatically determine the Terraform version
in the same way. You only need to run this action if you want to use the
outputs yourself.
## Inputs
* `path`
Path to the Terraform root module
- Type: string
- Optional
- Default: The action workspace
* `workspace`
The workspace to determine the Terraform version for.
- Type: string
- Optional
- Default: `default`
* `backend_config`
List of Terraform backend config values, one per line.
This will be used to fetch the Terraform version set in the cloud workspace if using the `remote` backend.
For other backend types, this is used to fetch the version that most recently wrote to the Terraform state.
```yaml
with:
backend_config: token=${{ secrets.BACKEND_TOKEN }}
```
- Type: string
- Optional
* `backend_config_file`
List of Terraform backend config files to use, one per line.
Paths should be relative to the GitHub Actions workspace
This will be used to fetch the Terraform version set in the cloud workspace if using the `remote` backend.
For other backend types, this is used to fetch the version that most recently wrote to the Terraform state.
```yaml
with:
backend_config_file: prod.backend.tfvars
```
- Type: string
- Optional
## Environment Variables
* `GITHUB_DOT_COM_TOKEN`
This is used to specify a token for GitHub.com when the action is running on a GitHub Enterprise instance.
This is only used for downloading OpenTofu binaries from GitHub.com.
If this is not set, an unauthenticated request will be made to GitHub.com to download the binary, which may be rate limited.
- Type: string
- Optional
* `TERRAFORM_CLOUD_TOKENS`
API tokens for cloud hosts, of the form `=`. Multiple tokens may be specified, one per line.
These tokens may be used for fetching required modules from the registry, and determining the Terraform version set in the remote workspace.
e.g:
```yaml
env:
TERRAFORM_CLOUD_TOKENS: app.terraform.io=${{ secrets.TF_CLOUD_TOKEN }}
```
With other registries:
```yaml
env:
TERRAFORM_CLOUD_TOKENS: |
app.terraform.io=${{ secrets.TF_CLOUD_TOKEN }}
terraform.example.com=${{ secrets.TF_REGISTRY_TOKEN }}
```
- Type: string
- Optional
* `TERRAFORM_SSH_KEY`
A SSH private key that Terraform will use to fetch git module sources.
This should be in PEM format.
For example:
```yaml
env:
TERRAFORM_SSH_KEY: ${{ secrets.TERRAFORM_SSH_KEY }}
```
- Type: string
- Optional
* `TERRAFORM_PRE_RUN`
A set of commands that will be ran prior to `terraform init`. This can be used to customise the environment before running Terraform.
The runtime environment for these actions is subject to change in minor version releases. If using this environment variable, specify the minor version of the action to use.
The runtime image is currently based on `debian:bullseye`, with the command run using `bash -xeo pipefail`.
For example:
```yaml
env:
TERRAFORM_PRE_RUN: |
# Install latest Azure CLI
curl -skL https://aka.ms/InstallAzureCLIDeb | bash
# Install postgres client
apt-get install -y --no-install-recommends postgresql-client
```
- Type: string
- Optional
* `TERRAFORM_HTTP_CREDENTIALS`
Credentials that will be used for fetching modules sources with `git::http://`, `git::https://`, `http://` & `https://` schemes.
Credentials have the format `=:`. Multiple credentials may be specified, one per line.
Each credential is evaluated in order, and the first matching credentials are used.
Credentials that are used by git (`git::http://`, `git::https://`) allow a path after the hostname.
Paths are ignored by `http://` & `https://` schemes.
For git module sources, a credential matches if each mentioned path segment is an exact match.
For example:
```yaml
env:
TERRAFORM_HTTP_CREDENTIALS: |
example.com=dflook:${{ secrets.HTTPS_PASSWORD }}
github.com/dflook/terraform-github-actions.git=dflook-actions:${{ secrets.ACTIONS_PAT }}
github.com/dflook=dflook:${{ secrets.DFLOOK_PAT }}
github.com=graham:${{ secrets.GITHUB_PAT }}
```
- Type: string
- Optional
## Outputs
* `terraform`
The Hashicorp Terraform or OpenTofu version that is used by the configuration.
* `tofu`
If the action chose a version of OpenTofu, this will be set to the version that is used by the configuration.
* Provider Versions
Additional outputs are added with the version of each provider that
is used by the Terraform configuration. For example, if the random
provider is used:
```hcl
provider "random" {
version = "2.2.0"
}
```
A `random` output will be created with the value `2.2.0`.
## Example usage
```yaml
on: [push]
jobs:
required_version:
runs-on: ubuntu-latest
name: Print the required Terraform and provider versions
steps:
- name: Checkout
uses: actions/checkout@v4
- name: Test terraform-version
uses: dflook/terraform-version@v1
id: terraform-version
with:
path: my-configuration
- name: Print the version
run: echo "The version was ${{ steps.terraform-version.outputs.terraform }}"
- name: Print aws provider version
run: echo "The aws provider version was ${{ steps.terraform-version.outputs.aws }}"
```