{"id":20334924,"url":"https://github.com/mdb/terrajux-action","last_synced_at":"2026-03-07T12:02:42.740Z","repository":{"id":49562818,"uuid":"374102757","full_name":"mdb/terrajux-action","owner":"mdb","description":"A GitHub Action for running terrajux","archived":false,"fork":false,"pushed_at":"2021-07-14T10:56:35.000Z","size":37,"stargazers_count":1,"open_issues_count":0,"forks_count":1,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-04-17T16:55:31.879Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Dockerfile","has_issues":true,"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/mdb.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2021-06-05T11:59:48.000Z","updated_at":"2021-07-14T10:55:23.000Z","dependencies_parsed_at":"2022-08-20T15:40:23.471Z","dependency_job_id":null,"html_url":"https://github.com/mdb/terrajux-action","commit_stats":null,"previous_names":[],"tags_count":24,"template":false,"template_full_name":null,"purl":"pkg:github/mdb/terrajux-action","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mdb%2Fterrajux-action","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mdb%2Fterrajux-action/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mdb%2Fterrajux-action/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mdb%2Fterrajux-action/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/mdb","download_url":"https://codeload.github.com/mdb/terrajux-action/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mdb%2Fterrajux-action/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":30212485,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-03-07T09:02:10.694Z","status":"ssl_error","status_checked_at":"2026-03-07T09:02:08.429Z","response_time":53,"last_error":"SSL_read: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"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":[],"created_at":"2024-11-14T20:38:35.904Z","updated_at":"2026-03-07T12:02:42.693Z","avatar_url":"https://github.com/mdb.png","language":"Dockerfile","funding_links":[],"categories":[],"sub_categories":[],"readme":"[![CI](https://github.com/mdb/terrajux-action/actions/workflows/main.yml/badge.svg)](https://github.com/mdb/terrajux-action/actions/workflows/main.yml)\n\n# terrajux-action\n\nA [GitHub Action](https://github.com/features/actions) for executing [terrajux](https://github.com/rhenning/terrajux).\n\n`terrajux-action` makes [Terraform](https://www.terraform.io) code review easier by reporting transitive module dependencies' [code diffs](https://en.wikipedia.org/wiki/Diff) alongside those associated with a [Terraform root module](https://www.terraform.io/docs/language/modules/index.html#the-root-module) edit.\n\n## Inputs\n\n### `git_url`\n\n**required** The Terraform module git repository URL to pass as `\u003cgiturl\u003e` to `terrajux`.\n\nFor common workflows, this might be `file://${{ github.workspace }}`. See [GitHub Actions `github` context](https://docs.github.com/en/actions/reference/context-and-expression-syntax-for-github-actions#github-context) for more information.\n\n### `v1_ref`\n\n**required** The GitHub Terraform module repository git ref to pass as `\u003cv1ref\u003e` to `terrajux`.\n\nFor common workflows, this might be `${{ github.ref }}`. See [GitHub Actions `github` context](https://docs.github.com/en/actions/reference/context-and-expression-syntax-for-github-actions#github-context) for more information.\n\n### `v2_ref`\n\n**required** The GitHub Terraform module repository git ref to pass as `\u003cv2ref\u003e` to `terrajux`.\n\nFor common workflows, this might be `${{ github.base_ref }}` or `${{ github.head_ref }}`. See [GitHub Actions `github` context](https://docs.github.com/en/actions/reference/context-and-expression-syntax-for-github-actions#github-context) for more information.\n\n### `subpath`\n\nThe GitHub module repository subpath to pass as the `\u003csubpath\u003e` to `terrajux`. Defaults to `\".\"`.\n\n### Example usage\n\nA common configuration to run `terrajux` against a pull request might look like the following:\n\n```yaml\n- uses: actions/checkout@main\n- uses: mdb/terrajux-action@main\n  with:\n    git_url: file://${{ github.workspace }}\n    v1_ref: ${{ github.ref }}\n    v2_ref: ${{ github.base_ref }}\n```\n\n...and would offer a diff view of all code differences -- including those amongst upstream Terraform module dependencies -- introduced by the pull request.\n\nAlternatively, `terrajux-action` can be run using a pre-built container image, which tends to be a bit faster:\n\n```yaml\n- uses: actions/checkout@main\n- uses: docker://registry.hub.docker.com/clapclapexcitement/terrajux-action:latest\n  with:\n    git_url: file://${{ github.workspace }}\n    v1_ref: ${{ github.ref }}\n    v2_ref: ${{ github.base_ref }}\n```\n\nSee `terrajux-action`'s own `.github/workflows` for additional examples.\n\n## TODO\n\n* more robust tests\n* associate changelog with each release\n* experimental: research techniques for exiting nonzero based on \"policy\" violations\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmdb%2Fterrajux-action","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmdb%2Fterrajux-action","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmdb%2Fterrajux-action/lists"}