terragrunt-generator
Generate documented terragrunt.hcl manifests from Terraform module variables.
terragrunt-generator generates terragrunt.hcl configuration files - with
documented inputs - from the variables exposed by a Terraform module. Point it
at a module (a git repository or a local directory), tell it where to look up
values, and it emits a ready-to-edit Terragrunt manifest plus an optional YAML
config skeleton.
Documentation
The project site is published from main to GitHub Pages:
https://goabonga.github.io/terragrunt-generator/.
Requirements
- Python 3.13+
Installation
pip install terragrunt-generator
Or run it without installing, using uv:
uvx terragrunt-generator --help
Usage
terragrunt-generator \
-u https://github.com/terraform-google-modules/terraform-google-project-factory.git \
-v v14.2.1 \
-l 'project'
This reads the module's variable blocks and prints a terragrunt.hcl whose
inputs are wired to a yamldecode-based config lookup:
# terraform-google-modules v14.2.1
# https://github.com/terraform-google-modules/terraform-google-project-factory/tree/v14.2.1/
include {
path = find_in_parent_folders()
}
locals {
source = "github.com/terraform-google-modules/terraform-google-project-factory.git?ref=v14.2.1"
all = merge(
yamldecode(file(find_in_parent_folders("config.yaml"))),
)
}
terraform {
source = lookup(local.all, "project", false) == false ? null : lookup(local.all.project, "enabled", false) == false ? null : local.source
}
inputs = merge({
billing_account = lookup(local.all.project, "billing_account", "")
name = lookup(local.all.project, "name", "")
org_id = lookup(local.all.project, "org_id", "")
activate_api_identities = lookup(local.all.project, "activate_api_identities", [])
activate_apis = lookup(local.all.project, "activate_apis", ["compute.googleapis.com"])
})
See the usage guide for the full option reference and the per-environment YAML workflow.
Development
git clone https://github.com/goabonga/terragrunt-generator.git
cd terragrunt-generator
uv sync
# Quality gates (mirrored in CI).
uv run ruff check src tests
uv run ruff format --check src tests
uv run mypy src
uv run pytest --cov=terragrunt_generator
# Install the pre-commit + commit-msg hooks.
uv run pre-commit install
Versioning and release
Releases are automated. Every push to main runs
multicz bump --commit --tag --push - driven by
Conventional Commits - then publishes
to PyPI and deploys the docs.
# Preview the next release against the current branch.
multicz status
Contributing
See CONTRIBUTING.md for the workflow, the commit-message convention, and the test/lint expectations. By participating you agree to the Code of Conduct.
Security issues: please follow the disclosure process in SECURITY.md.
License
Distributed under the MIT License.
1 maintainer
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file terragrunt_generator-1.1.3.tar.gz.
File metadata
- Download URL: terragrunt_generator-1.1.3.tar.gz
- Upload date:
- Size: 15.4 kB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via:
twine/7.0.0 CPython/3.13.14
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
aa5a4b073291000394c02175a03b845938aee9c03b5fe14a0143e23e6be97730
|
|
| MD5 |
8c2fd283969186790333c5a9a71aca14
|
|
| BLAKE2b-256 |
f09224dc4aabf48b5d885ce540a33daddeae95c7a39068f9b5eb2956b38dee7b
|
Provenance
The following attestation bundles were made for terragrunt_generator-1.1.3.tar.gz:
Publisher:
ci.yml on goabonga/terragrunt-generator
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
terragrunt_generator-1.1.3.tar.gz -
Subject digest:
aa5a4b073291000394c02175a03b845938aee9c03b5fe14a0143e23e6be97730 - Sigstore transparency entry: 2710567887
- Sigstore integration time:
-
Permalink:
goabonga/terragrunt-generator@2e36b0619baa309191e2b382dfe3967a13b67202 -
Branch / Tag:
refs/heads/main - Owner: https://github.com/goabonga
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
ci.yml@2e36b0619baa309191e2b382dfe3967a13b67202 -
Trigger Event:
push
-
Statement type:
File details
Details for the file terragrunt_generator-1.1.3-py3-none-any.whl.
File metadata
- Download URL: terragrunt_generator-1.1.3-py3-none-any.whl
- Upload date:
- Size: 11.7 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via:
twine/7.0.0 CPython/3.13.14
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
66f50ca61dcb89e7ba040b78bafffac6c2658dc307967e4cb4758460ba257474
|
|
| MD5 |
65371989f3326cc9add4c145a95a9c36
|
|
| BLAKE2b-256 |
ad02b51d746a8267d8458c6c686cc6b21b016d13dbe12962a9c02c9cf609c667
|
Provenance
The following attestation bundles were made for terragrunt_generator-1.1.3-py3-none-any.whl:
Publisher:
ci.yml on goabonga/terragrunt-generator
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
terragrunt_generator-1.1.3-py3-none-any.whl -
Subject digest:
66f50ca61dcb89e7ba040b78bafffac6c2658dc307967e4cb4758460ba257474 - Sigstore transparency entry: 2710567912
- Sigstore integration time:
-
Permalink:
goabonga/terragrunt-generator@2e36b0619baa309191e2b382dfe3967a13b67202 -
Branch / Tag:
refs/heads/main - Owner: https://github.com/goabonga
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
ci.yml@2e36b0619baa309191e2b382dfe3967a13b67202 -
Trigger Event:
push
-
Statement type:
