https://github.com/devops-infra/action-terraform-copy-vars
GitHub Action automatically copying variables' definitions from a single file to many modules
https://github.com/devops-infra/action-terraform-copy-vars
action-terraform automation ci-cd cicd devops devops-workflow docker dockerhub github-action github-action-docker github-actions github-actions-docker iaac terraform terraform-modules terragrunt
Last synced: 5 months ago
JSON representation
GitHub Action automatically copying variables' definitions from a single file to many modules
- Host: GitHub
- URL: https://github.com/devops-infra/action-terraform-copy-vars
- Owner: devops-infra
- License: mit
- Created: 2020-04-08T22:40:40.000Z (about 5 years ago)
- Default Branch: master
- Last Pushed: 2025-02-03T01:32:53.000Z (5 months ago)
- Last Synced: 2025-02-05T17:06:22.665Z (5 months ago)
- Topics: action-terraform, automation, ci-cd, cicd, devops, devops-workflow, docker, dockerhub, github-action, github-action-docker, github-actions, github-actions-docker, iaac, terraform, terraform-modules, terragrunt
- Language: Python
- Homepage: https://christophshyper.github.io/
- Size: 135 KB
- Stars: 1
- Watchers: 3
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
# GitHub Action coping Terraform variables across modules
**GitHub Action automatically copying variables' definitions from a single file to many modules.**
Dockerized as [devopsinfra/action-terraform-copy-vars](https://hub.docker.com/repository/docker/devopsinfra/action-terraform-copy-vars).
Features:
* It's main use will be everywhere where [Terraform](https://github.com/hashicorp/terraform) is used with *more than one module in a **monorepo***.
* Reads file defined with `all_vars_file` and will use whole definitions of variables from it.
* For every module matching `dirs_with_modules` will search files matching `files_with_vars` and replace matching variables from `all_vars_file`.
* To not loose the changes combine with my other action [devops-infra/action-commit-push](https://github.com/devops-infra/action-commit-push).
## Badge swag
[](https://github.com/devops-infra/action-terraform-copy-vars/actions?query=workflow%3A%22Master+branch%22)
[](https://github.com/devops-infra/action-terraform-copy-vars/actions?query=workflow%3A%22Other+branches%22)
[
](https://github.com/devops-infra/action-terraform-copy-vars "shields.io")
[
](https://hub.docker.com/r/devopsinfra/action-terraform-copy-vars "shields.io")
## Reference
```yaml
- name: Fail on different veriables' definitions
uses: devops-infra/[email protected]
with:
fail_on_changes: true
```
Input Variable | Required | Default |Description
:--- | :---: | :---: | :---
dirs_with_modules | No | `terraform` | Comma separated list of directory prefixes with modules.
files_with_vars | No | `variables.tf` | Comma separated list of files containing variables in directories matching `dirs_with_modules`.
all_vars_file | No | `all-variables.tf` | Name of a file containing base definitions of all variables.
fail_on_missing | No | `false` | Whether action should fail if `all_vars_file` is missing some definitions from modules.
## Examples
Fail action if not all variables in `variables.tf` in `terragrunt` subdirectories match their definitions in `all-variables.tf`.
```yaml
name: Check Terraform variables
on:
push
jobs:
terraform-copy-vars:
runs-on: ubuntu-latest
steps:
- name: Checkout repoistory
uses: actions/checkout@v2
- name: Fail on different veriables' definitions
uses: devops-infra/[email protected]
with:
fail_on_changes: true
```
Copy variables definitions from `all-variables.tf` to all `variables.tf` in `modules` subdirectories and commit updated files back to the repository using my other action [devops-infra/action-commit-push](https://github.com/devops-infra/action-commit-push).
```yaml
name: Copy Terraform variables accross modules
on:
push
jobs:
terraform-copy-vars:
runs-on: ubuntu-latest
steps:
- name: Checkout repoistory
uses: actions/checkout@v2
- name: Update Terraform variables
uses: devops-infra/[email protected]
with:
dirs_with_modules: modules
files_with_vars: variables.tf
all_vars_file: all-variables.tf
- name: Commit changes to repo
uses: devops-infra/action-commit-push@master
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
commit_prefix: "[AUTO-VARIABLES]"
```