{"id":26009961,"url":"https://github.com/byu-oit/github-action-tf-plan-comment","last_synced_at":"2026-02-06T06:02:46.529Z","repository":{"id":40283246,"uuid":"274471687","full_name":"byu-oit/github-action-tf-plan-comment","owner":"byu-oit","description":"GitHub Action to make a comment on a pull request with the proposed updated terraform plan","archived":false,"fork":false,"pushed_at":"2024-09-12T02:26:02.000Z","size":1207,"stargazers_count":0,"open_issues_count":3,"forks_count":0,"subscribers_count":22,"default_branch":"master","last_synced_at":"2025-10-22T06:07:55.043Z","etag":null,"topics":["github-action"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/byu-oit.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","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}},"created_at":"2020-06-23T17:46:23.000Z","updated_at":"2024-06-25T19:35:07.000Z","dependencies_parsed_at":"2024-06-25T19:10:29.594Z","dependency_job_id":"61cb6ceb-de0f-4b26-8424-47b40291f4a2","html_url":"https://github.com/byu-oit/github-action-tf-plan-comment","commit_stats":{"total_commits":79,"total_committers":5,"mean_commits":15.8,"dds":"0.11392405063291144","last_synced_commit":"1ccc1eb37f548c84927b1ecd4ee9b0ffa9c25ff1"},"previous_names":[],"tags_count":9,"template":false,"template_full_name":"actions/typescript-action","purl":"pkg:github/byu-oit/github-action-tf-plan-comment","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/byu-oit%2Fgithub-action-tf-plan-comment","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/byu-oit%2Fgithub-action-tf-plan-comment/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/byu-oit%2Fgithub-action-tf-plan-comment/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/byu-oit%2Fgithub-action-tf-plan-comment/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/byu-oit","download_url":"https://codeload.github.com/byu-oit/github-action-tf-plan-comment/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/byu-oit%2Fgithub-action-tf-plan-comment/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":29153144,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-02-06T02:39:25.012Z","status":"ssl_error","status_checked_at":"2026-02-06T02:37:22.784Z","response_time":59,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.5:443 state=error: 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":["github-action"],"created_at":"2025-03-05T22:26:38.910Z","updated_at":"2026-02-06T06:02:46.512Z","avatar_url":"https://github.com/byu-oit.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"![CI](https://github.com/byu-oit/github-action-tf-plan-comment/workflows/CI/badge.svg)\n![Test](https://github.com/byu-oit/github-action-tf-plan-comment/workflows/Test/badge.svg)\n\n# ![BYU logo](https://www.hscripts.com/freeimages/logos/university-logos/byu/byu-logo-clipart-128.gif) github-action-tf-plan-comment\n\nGitHub Action to make a comment on a pull request with the proposed updated terraform plan\n\nThis action takes in the terraform plan and creates a comment on the Pull Request (PR) with basic info about what the plan will create, update, replace, or delete.\n\n**Note:** this action does not run `terraform plan` for you, you must pass in the plan as an input as well as the directory of the terraform configuration (where the plan and .terraform dir are located after `terraform init`).\n\n## Usage\n```yaml\non: pull_request\n# ...\njobs:\n  build:\n    runs-on: ubuntu-latest\n    steps:\n    # ... \n    # terraform init\n    # terraform plan\n    - name: Comment Terraform Plan\n      uses: byu-oit/github-action-tf-plan-comment@v1\n      with:\n        github-token: ${{ secrets.GITHUB_TOKEN }}\n        working-directory: terraform-iac/dev/app # where your terraform files are\n        terraform-plan-file: plan.tfplan # relative to working directory\n```\n\n## Inputs\n* `github-token` - (**required**) pass in the GitHub token to make comments on the PR\n* `working-directory` - (_optional_) the directory of the terraform configuration files (defaults to `.`)\n* `terraform-plan-file` - (**required**) Filename of the terraform plan (relative to `working-directory`)\n* `comment-title` - (_optional_) Title for the comment this action will make on your pull request (defaults to `Terraform Plan`)\n    \n**note**: the `comment-title` is used to determine which PR comment to update.\nFor instance if you have two of these actions in one PR with the same `comment-title` then they will both try to update the same comment.\n\n## Output\nThis action will create a comment on your PR like:\n\n\u003e ## Terraform Plan:\n\u003e will **replace (delete then create)** 1 resources:\n\u003e - aws_security_group_rule - db_access\n\u003e \n\u003e will **delete** 1 resources:\n\u003e - aws_db_instance - database\n\u003e \n\u003e[see details](link to the github action workflow)\n\n## Contributing\nHopefully this is useful to others at BYU.\nFeel free to ask me some questions about it, but I make no promises about being able to commit time to support it.\n\nGitHub Actions will run the entry point from the action.yml.\nIn our case, that happens to be /dist/index.js.\n\nActions run from GitHub repos.\nWe don't want to check in node_modules. \nHence, we package the app using `yarn run pack`.\nMake sure you run `yarn run pack` before committing/pushing.\n\n### Modifying Source Code\nJust run `yarn install` locally.\nThere aren't many files here, so hopefully it should be pretty straightforward.\n\n### Cutting new releases\nPush your code up to a feature branch.\nCreate a pull request to the `v1` branch (if it's a non breaking change).\n\nAfter it's merged into the `v1` branch then, be sure to create a new GitHub release, following SemVer.\nThen merge `v1` into `master`.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbyu-oit%2Fgithub-action-tf-plan-comment","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fbyu-oit%2Fgithub-action-tf-plan-comment","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbyu-oit%2Fgithub-action-tf-plan-comment/lists"}