https://github.com/suzuki-shunsuke/tfrstate
Find directories where changed terraform_remote_state data source is used
https://github.com/suzuki-shunsuke/tfrstate
cli oss terraform
Last synced: 13 days ago
JSON representation
Find directories where changed terraform_remote_state data source is used
- Host: GitHub
- URL: https://github.com/suzuki-shunsuke/tfrstate
- Owner: suzuki-shunsuke
- License: mit
- Created: 2024-11-26T02:29:17.000Z (5 months ago)
- Default Branch: main
- Last Pushed: 2025-04-23T05:09:25.000Z (14 days ago)
- Last Synced: 2025-04-23T06:22:21.601Z (14 days ago)
- Topics: cli, oss, terraform
- Language: Go
- Homepage:
- Size: 216 KB
- Stars: 14
- Watchers: 1
- Forks: 1
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# tfrstate (Terraform Remote State)
[MIT](LICENSE) | [Install](INSTALL.md) | [Usage](USAGE.md)
CLI to find directories where changed [terraform_remote_state data source](https://developer.hashicorp.com/terraform/language/state/remote-state-data) is used.
You can warn changes of Terraform Output Values in CI:
You can also create pull requests via CI to reflect changes of Output Values to Terraform Root Modules:
## Overview
When [Terraform Output Values](https://developer.hashicorp.com/terraform/language/values/outputs) are updated, you would want to reflect the update to Terraform Root Modules where referring those values via `terrform_remote_state` data sources.
Or when you remove Terraform Output Values, you would want to know which Terraform Root Modules are depending on those values.
tfrstate is a CLI to find Terraform Root Modules depending on a given Terraform State via `terraform_remote_state`.
Using this tool, you can look into the dependency, notifying to people when changing output values in CI, and creating pull requests to reflect changes of output values after applying changes.
## Supported Backends
- [S3 Backend](https://developer.hashicorp.com/terraform/language/backend/s3)
- [GCS Backend](https://developer.hashicorp.com/terraform/language/backend/gcs)
## How To Use
[Please see PoC too](https://github.com/suzuki-shunsuke/poc-tfrstate).
1. Check directories where a specific output is used.
```sh
tfrstate find -s3-bucket mybucket -s3-key path/to/my/key -output foo
```
2. Post a comment when outputs are changed in CI
```sh
terraform plan -out plan.out
terraform show -json plan.out > plan.json
tfrstate find -plan-json plan.json -base-dir "$(git rev-parse --show-toplevel)" > result.json
length=$(jq length result.json)
if [ "$length" -eq 0 ]; then
exit 0
fi
# Post a comment
```
To post comments, [github-comment](https://github.com/suzuki-shunsuke/github-comment) is useful.
3. Create pull requests after running `terraform apply`
```sh
terraform apply -auto-approve plan.out
while read -r dir; do
echo "[INFO] Creating a pull request: $dir" >&2
# Create a pull request
done < <(jq -r ".[].dir" result.json)
```
## Output Format
```json
[
{
"dir": "A directory where depending on changed outputs. A relative path from the base directory",
"files": [
{
"path": "A file depending on changed outputs. A relative path from dir",
"outputs": [
"changed output name"
]
}
]
}
]
```
## LICENSE
[MIT](LICENSE)