{"id":21261399,"url":"https://github.com/dflook/terraform-validate","last_synced_at":"2025-07-11T03:31:28.035Z","repository":{"id":61301414,"uuid":"277396560","full_name":"dflook/terraform-validate","owner":"dflook","description":"GitHub action to validate a terraform configuration","archived":false,"fork":false,"pushed_at":"2025-06-16T14:40:17.000Z","size":310,"stargazers_count":12,"open_issues_count":0,"forks_count":6,"subscribers_count":3,"default_branch":"main","last_synced_at":"2025-07-06T23:38:36.057Z","etag":null,"topics":["actions","devops","github-action","github-actions","terraform"],"latest_commit_sha":null,"homepage":"","language":null,"has_issues":false,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/dflook.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":".github/FUNDING.yml","license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null},"funding":{"github":["dflook"]}},"created_at":"2020-07-05T22:54:32.000Z","updated_at":"2025-06-16T14:40:17.000Z","dependencies_parsed_at":"2023-02-18T01:31:22.944Z","dependency_job_id":"58387ee2-11e5-4576-b76e-691b5f9884ff","html_url":"https://github.com/dflook/terraform-validate","commit_stats":{"total_commits":57,"total_committers":1,"mean_commits":57.0,"dds":0.0,"last_synced_commit":"9eafdcd69fd95a8e4775582de3a8df88978b5506"},"previous_names":[],"tags_count":316,"template":false,"template_full_name":null,"purl":"pkg:github/dflook/terraform-validate","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dflook%2Fterraform-validate","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dflook%2Fterraform-validate/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dflook%2Fterraform-validate/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dflook%2Fterraform-validate/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/dflook","download_url":"https://codeload.github.com/dflook/terraform-validate/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dflook%2Fterraform-validate/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":264721304,"owners_count":23653917,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["actions","devops","github-action","github-actions","terraform"],"created_at":"2024-11-21T04:29:26.028Z","updated_at":"2025-07-11T03:31:28.021Z","avatar_url":"https://github.com/dflook.png","language":null,"readme":"# terraform-validate action\n\nThis is one of a suite of Terraform related actions - find them at [dflook/terraform-github-actions](https://github.com/dflook/terraform-github-actions).\n\nThis action uses the `terraform validate` command to check that a Terraform configuration is valid.\nThis can be used to check that a configuration is valid before creating a plan.\n\nFailing GitHub checks will be added for any problems found.\n\n\u003cp align=\"center\"\u003e\n    \u003cimg src=\"validate.png\" width=\"1000\" alt=\"An example of a failed validation check\"\u003e\n\u003c/p\u003e\n\nIf the Terraform configuration is not valid, the build is failed.\n\n## Inputs\n\n* `path`\n\n  The path to the Terraform module to validate\n\n  - Type: string\n  - Optional\n  - Default: The action workspace\n\n* `workspace`\n\n  Terraform workspace to use for the `terraform.workspace` value while validating. Note that for remote operations in a cloud backend, this is always `default`.\n\n  Also used for discovering the Terraform version to use, if not otherwise specified.\n  See [dflook/terraform-version](https://github.com/dflook/terraform-github-actions/tree/main/terraform-version#terraform-version-action) for details.\n\n  - Type: string\n  - Optional\n  - Default: `default`\n\n* `backend_config`\n\n  List of Terraform backend config values, one per line.\n  This is used for discovering the Terraform version to use, if not otherwise specified.\n  See [dflook/terraform-version](https://github.com/dflook/terraform-github-actions/tree/main/terraform-version#terraform-version-action) for details.\n\n  ```yaml\n  with:\n    backend_config: token=${{ secrets.BACKEND_TOKEN }}\n  ```\n\n  - Type: string\n  - Optional\n\n* `backend_config_file`\n\n  List of Terraform backend config files to use, one per line.\n  Paths should be relative to the GitHub Actions workspace\n  This is used for discovering the Terraform version to use, if not otherwise specified.\n  See [dflook/terraform-version](https://github.com/dflook/terraform-github-actions/tree/main/terraform-version#terraform-version-action) for details.\n\n  ```yaml\n  with:\n    backend_config_file: prod.backend.tfvars\n  ```\n\n  - Type: string\n  - Optional\n\n## Outputs\n\n* `failure-reason`\n\n  When the job outcome is `failure` because the validation failed, this will be set to 'validate-failed'.\n  If the job fails for any other reason this will not be set.\n  This can be used with the Actions expression syntax to conditionally run a step when the validate fails.\n\n  - Type: string\n\n## Environment Variables\n\n* `GITHUB_DOT_COM_TOKEN`\n\n  This is used to specify a token for GitHub.com when the action is running on a GitHub Enterprise instance.\n  This is only used for downloading OpenTofu binaries from GitHub.com.\n  If this is not set, an unauthenticated request will be made to GitHub.com to download the binary, which may be rate limited.\n\n  - Type: string\n  - Optional\n\n* `TERRAFORM_CLOUD_TOKENS`\n\n  API tokens for cloud hosts, of the form `\u003chost\u003e=\u003ctoken\u003e`. Multiple tokens may be specified, one per line.\n  These tokens may be used with the `remote` backend and for fetching required modules from the registry.\n\n  e.g:\n\n  ```yaml\n  env:\n    TERRAFORM_CLOUD_TOKENS: app.terraform.io=${{ secrets.TF_CLOUD_TOKEN }}\n  ```\n\n  With other registries:\n\n  ```yaml\n  env:\n    TERRAFORM_CLOUD_TOKENS: |\n      app.terraform.io=${{ secrets.TF_CLOUD_TOKEN }}\n      terraform.example.com=${{ secrets.TF_REGISTRY_TOKEN }}\n  ```\n\n  - Type: string\n  - Optional\n\n* `TERRAFORM_SSH_KEY`\n\n  A SSH private key that Terraform will use to fetch git/mercurial module sources.\n\n  This should be in PEM format.\n\n  For example:\n\n  ```yaml\n  env:\n    TERRAFORM_SSH_KEY: ${{ secrets.TERRAFORM_SSH_KEY }}\n  ```\n\n  - Type: string\n  - Optional\n\n* `TERRAFORM_HTTP_CREDENTIALS`\n\n  Credentials that will be used for fetching modules sources with `git::http://`, `git::https://`, `http://` \u0026 `https://` schemes.\n\n  Credentials have the format `\u003chost\u003e=\u003cusername\u003e:\u003cpassword\u003e`. Multiple credentials may be specified, one per line.\n\n  Each credential is evaluated in order, and the first matching credentials are used.\n\n  Credentials that are used by git (`git::http://`, `git::https://`) allow a path after the hostname.\n  Paths are ignored by `http://` \u0026 `https://` schemes.\n  For git module sources, a credential matches if each mentioned path segment is an exact match.\n\n  For example:\n\n  ```yaml\n  env:\n    TERRAFORM_HTTP_CREDENTIALS: |\n      example.com=dflook:${{ secrets.HTTPS_PASSWORD }}\n      github.com/dflook/terraform-github-actions.git=dflook-actions:${{ secrets.ACTIONS_PAT }}\n      github.com/dflook=dflook:${{ secrets.DFLOOK_PAT }}\n      github.com=graham:${{ secrets.GITHUB_PAT }}  \n  ```\n\n  - Type: string\n  - Optional\n\n* `TERRAFORM_PRE_RUN`\n\n  A set of commands that will be ran prior to `terraform init`. This can be used to customise the environment before running Terraform.\n\n  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.\n\n  The runtime image is currently based on `debian:bookworm`, with the command run using `bash -xeo pipefail`.\n\n  For example:\n\n  ```yaml\n  env:\n    TERRAFORM_PRE_RUN: |\n      # Install latest Azure CLI\n      curl -skL https://aka.ms/InstallAzureCLIDeb | bash\n\n      # Install postgres client\n      apt-get install -y --no-install-recommends postgresql-client\n  ```\n\n  - Type: string\n  - Optional\n\n## Example usage\n\nThis example workflow runs on every push and fails if the Terraform\nconfiguration is invalid.\n\n```yaml\non: [push]\n\njobs:\n  validate:\n    runs-on: ubuntu-latest\n    name: Validate Terraform module\n    steps:\n      - name: Checkout\n        uses: actions/checkout@v4\n\n      - name: terraform validate\n        uses: dflook/terraform-validate@v2\n        with:\n          path: my-terraform-config\n```\n\nThis example executes a run step only if the validation failed.\n\n```yaml\non: [push]\n\njobs:\n  validate:\n    runs-on: ubuntu-latest\n    name: Validate Terraform module\n    steps:\n      - name: Checkout\n        uses: actions/checkout@v4\n\n      - name: terraform validate\n        uses: dflook/terraform-validate@v2\n        id: validate\n        with:\n          path: my-terraform-config\n\n      - name: Validate failed\n        if: ${{ failure() \u0026\u0026 steps.validate.outputs.failure-reason == 'validate-failed' }}\n        run: echo \"terraform validate failed\"\n```\n","funding_links":["https://github.com/sponsors/dflook"],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdflook%2Fterraform-validate","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdflook%2Fterraform-validate","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdflook%2Fterraform-validate/lists"}