{"id":13574904,"url":"https://github.com/aquasecurity/tfsec-pr-commenter-action","last_synced_at":"2025-10-13T07:22:31.804Z","repository":{"id":38197154,"uuid":"308285596","full_name":"aquasecurity/tfsec-pr-commenter-action","owner":"aquasecurity","description":"Add comments to pull requests where tfsec checks have failed","archived":false,"fork":false,"pushed_at":"2023-09-20T07:49:40.000Z","size":594,"stargazers_count":167,"open_issues_count":24,"forks_count":65,"subscribers_count":6,"default_branch":"main","last_synced_at":"2025-05-19T21:39:49.873Z","etag":null,"topics":["hacktoberfest","pr","pr-comment","tfsec","tfsec-checks"],"latest_commit_sha":null,"homepage":"","language":"Go","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/aquasecurity.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-10-29T09:56:56.000Z","updated_at":"2025-03-31T00:02:47.000Z","dependencies_parsed_at":"2024-06-18T12:25:05.233Z","dependency_job_id":"51abc25b-8362-471a-b018-eaf90027e38a","html_url":"https://github.com/aquasecurity/tfsec-pr-commenter-action","commit_stats":{"total_commits":88,"total_committers":18,"mean_commits":4.888888888888889,"dds":0.5113636363636364,"last_synced_commit":"5b483d46fb4fd0cbe2259cf68354a3fb23aa70fe"},"previous_names":["tfsec/tfsec-github-commenter-action"],"tags_count":42,"template":false,"template_full_name":null,"purl":"pkg:github/aquasecurity/tfsec-pr-commenter-action","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/aquasecurity%2Ftfsec-pr-commenter-action","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/aquasecurity%2Ftfsec-pr-commenter-action/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/aquasecurity%2Ftfsec-pr-commenter-action/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/aquasecurity%2Ftfsec-pr-commenter-action/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/aquasecurity","download_url":"https://codeload.github.com/aquasecurity/tfsec-pr-commenter-action/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/aquasecurity%2Ftfsec-pr-commenter-action/sbom","scorecard":{"id":204686,"data":{"date":"2025-08-11","repo":{"name":"github.com/aquasecurity/tfsec-pr-commenter-action","commit":"5b483d46fb4fd0cbe2259cf68354a3fb23aa70fe"},"scorecard":{"version":"v5.2.1-40-gf6ed084d","commit":"f6ed084d17c9236477efd66e5b258b9d4cc7b389"},"score":4.4,"checks":[{"name":"Code-Review","score":10,"reason":"all changesets reviewed","details":null,"documentation":{"short":"Determines if the project requires human code review before pull requests (aka merge requests) are merged.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#code-review"}},{"name":"Dangerous-Workflow","score":10,"reason":"no dangerous workflow patterns detected","details":null,"documentation":{"short":"Determines if the project's GitHub Action workflows avoid dangerous patterns.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#dangerous-workflow"}},{"name":"Maintained","score":0,"reason":"0 commit(s) and 0 issue activity found in the last 90 days -- score normalized to 0","details":null,"documentation":{"short":"Determines if the project is \"actively maintained\".","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#maintained"}},{"name":"Token-Permissions","score":0,"reason":"detected GitHub workflow tokens with excessive permissions","details":["Warn: no topLevel permission defined: .github/workflows/release.yml:1","Info: no jobLevel write permissions found"],"documentation":{"short":"Determines if the project's workflows follow the principle of least privilege.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#token-permissions"}},{"name":"Binary-Artifacts","score":10,"reason":"no binaries found in the repo","details":null,"documentation":{"short":"Determines if the project has generated executable (binary) artifacts in the source repository.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#binary-artifacts"}},{"name":"CII-Best-Practices","score":0,"reason":"no effort to earn an OpenSSF best practices badge detected","details":null,"documentation":{"short":"Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#cii-best-practices"}},{"name":"Fuzzing","score":0,"reason":"project is not fuzzed","details":["Warn: no fuzzer integrations found"],"documentation":{"short":"Determines if the project uses fuzzing.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#fuzzing"}},{"name":"License","score":10,"reason":"license file detected","details":["Info: project has a license file: LICENSE:0","Info: FSF or OSI recognized license: MIT License: LICENSE:0"],"documentation":{"short":"Determines if the project has defined a license.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#license"}},{"name":"Packaging","score":-1,"reason":"packaging workflow not detected","details":["Warn: no GitHub/GitLab publishing workflow detected."],"documentation":{"short":"Determines if the project is published as a package that others can easily download, install, easily update, and uninstall.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#packaging"}},{"name":"Signed-Releases","score":0,"reason":"Project has not signed or included provenance with any releases.","details":["Warn: release artifact v1.3.1 not signed: https://api.github.com/repos/aquasecurity/tfsec-pr-commenter-action/releases/81841054","Warn: release artifact v1.3.0 not signed: https://api.github.com/repos/aquasecurity/tfsec-pr-commenter-action/releases/81553221","Warn: release artifact v1.2.0 not signed: https://api.github.com/repos/aquasecurity/tfsec-pr-commenter-action/releases/62666778","Warn: release artifact v1.1.0 not signed: https://api.github.com/repos/aquasecurity/tfsec-pr-commenter-action/releases/61283358","Warn: release artifact v1.1.0-beta.2 not signed: https://api.github.com/repos/aquasecurity/tfsec-pr-commenter-action/releases/61283168","Warn: release artifact v1.3.1 does not have provenance: https://api.github.com/repos/aquasecurity/tfsec-pr-commenter-action/releases/81841054","Warn: release artifact v1.3.0 does not have provenance: https://api.github.com/repos/aquasecurity/tfsec-pr-commenter-action/releases/81553221","Warn: release artifact v1.2.0 does not have provenance: https://api.github.com/repos/aquasecurity/tfsec-pr-commenter-action/releases/62666778","Warn: release artifact v1.1.0 does not have provenance: https://api.github.com/repos/aquasecurity/tfsec-pr-commenter-action/releases/61283358","Warn: release artifact v1.1.0-beta.2 does not have provenance: https://api.github.com/repos/aquasecurity/tfsec-pr-commenter-action/releases/61283168"],"documentation":{"short":"Determines if the project cryptographically signs release artifacts.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#signed-releases"}},{"name":"Branch-Protection","score":-1,"reason":"internal error: error during branchesHandler.setup: internal error: githubv4.Query: Resource not accessible by integration","details":null,"documentation":{"short":"Determines if the default and release branches are protected with GitHub's branch protection settings.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#branch-protection"}},{"name":"Pinned-Dependencies","score":0,"reason":"dependency not pinned by hash detected -- score normalized to 0","details":["Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/release.yml:13: update your workflow using https://app.stepsecurity.io/secureworkflow/aquasecurity/tfsec-pr-commenter-action/release.yml/main?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/release.yml:15: update your workflow using https://app.stepsecurity.io/secureworkflow/aquasecurity/tfsec-pr-commenter-action/release.yml/main?enable=pin","Warn: third-party GitHubAction not pinned by hash: .github/workflows/release.yml:22: update your workflow using https://app.stepsecurity.io/secureworkflow/aquasecurity/tfsec-pr-commenter-action/release.yml/main?enable=pin","Warn: containerImage not pinned by hash: Dockerfile:1: pin your Docker image by updating public.ecr.aws/docker/library/alpine:3.12 to public.ecr.aws/docker/library/alpine:3.12@sha256:c75ac27b49326926b803b9ed43bf088bc220d22556de1bc5f72d742c91398f69","Info:   0 out of   2 GitHub-owned GitHubAction dependencies pinned","Info:   0 out of   1 third-party GitHubAction dependencies pinned","Info:   0 out of   1 containerImage dependencies pinned"],"documentation":{"short":"Determines if the project has declared and pinned the dependencies of its build process.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#pinned-dependencies"}},{"name":"Security-Policy","score":0,"reason":"security policy file not detected","details":["Warn: no security policy file detected","Warn: no security file to analyze","Warn: no security file to analyze","Warn: no security file to analyze"],"documentation":{"short":"Determines if the project has published a security policy.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#security-policy"}},{"name":"SAST","score":0,"reason":"SAST tool is not run on all commits -- score normalized to 0","details":["Warn: 0 commits out of 30 are checked with a SAST tool"],"documentation":{"short":"Determines if the project uses static code analysis.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#sast"}},{"name":"Vulnerabilities","score":10,"reason":"0 existing vulnerabilities detected","details":null,"documentation":{"short":"Determines if the project has open, known unfixed vulnerabilities.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#vulnerabilities"}}]},"last_synced_at":"2025-08-16T23:27:50.679Z","repository_id":38197154,"created_at":"2025-08-16T23:27:50.679Z","updated_at":"2025-08-16T23:27:50.679Z"},"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":279014111,"owners_count":26085463,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-10-13T02:00:06.723Z","response_time":61,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"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":["hacktoberfest","pr","pr-comment","tfsec","tfsec-checks"],"created_at":"2024-08-01T15:00:56.068Z","updated_at":"2025-10-13T07:22:31.776Z","avatar_url":"https://github.com/aquasecurity.png","language":"Go","funding_links":[],"categories":["Go"],"sub_categories":[],"readme":"\u003cp align=\"center\"\u003e\n  \u003cimg width=\"354\" src=\"./tfsec.png\"\u003e\n\u003c/p\u003e\n\n# tfsec-pr-commenter-action\nAdd comments to pull requests where tfsec checks have failed\n\nTo add the action, add `tfsec_pr_commenter.yml` into the `.github/workflows` directory in the root of your Github project.\n\nThe contents of `tfsec_pr_commenter.yml` should be;\n\n\u003e **Note**: The GITHUB_TOKEN injected to the workflow will need permissions to write on pull requests.\n\u003e\n\u003e This can be achieved by adding a permissions block in your workflow definition.\n\u003e\n\u003e See: [docs.github.com/en/actions/using-jobs/assigning-permissions-to-jobs](https://docs.github.com/en/actions/using-jobs/assigning-permissions-to-jobs)\n\u003e for more details.\n\n```yaml\nname: tfsec-pr-commenter\non:\n  pull_request:\njobs:\n  tfsec:\n    name: tfsec PR commenter\n    runs-on: ubuntu-latest\n\n    permissions:\n      contents: read\n      pull-requests: write\n\n    steps:\n      - name: Clone repo\n        uses: actions/checkout@master\n      - name: tfsec\n        uses: aquasecurity/tfsec-pr-commenter-action@v1.2.0\n        with:\n          github_token: ${{ github.token }}\n```\n\nOn each pull request and subsequent commit, tfsec will run and add comments to the PR where tfsec has failed.\n\nThe comment will only be added once per transgression.\n\n## Optional inputs\n\nThere are a number of optional inputs that can be used in the `with:` block.\n\n**working_directory** - the directory to scan in, defaults to `.`, ie current working directory\n\n**tfsec_version** - the version of tfsec to use, defaults to `latest`\n\n**tfsec_args** - the args for tfsec to use (space-separated)\n\n**tfsec_formats** - the formats for tfsec to output (comma-separated)\n\n**commenter_version** - the version of the commenter to use, defaults to `latest`\n\n**soft_fail_commenter** - set to `true` to comment silently without breaking the build\n\n### tfsec_args\n\n`tfsec` provides an [extensive number of arguments](https://aquasecurity.github.io/tfsec/latest/guides/usage/), which can be passed through as in the example below:\n\n```yaml\nname: tfsec-pr-commenter\non:\n  pull_request:\njobs:\n  tfsec:\n    name: tfsec PR commenter\n    runs-on: ubuntu-latest\n\n    steps:\n      - name: Clone repo\n        uses: actions/checkout@master\n      - name: tfsec\n        uses: aquasecurity/tfsec-pr-commenter-action@v1.2.0\n        with:\n          tfsec_args: --soft-fail\n          github_token: ${{ github.token }}\n```\n\n### tfsec_formats\n\n`tfsec` provides multiple possible formats for the output:\n\n* default\n* json\n* csv\n* checkstyle\n* junit\n* sarif\n* gif\n\nThe `json` format is required and included by default. To add additional formats, set the `tfsec_formats` option to comma-separated values:\n\n```yaml\ntfsec_formats: sarif,csv\n```\n\n## Example PR Comment\n\nThe screenshot below demonstrates the comments that can be expected when using the action\n\n![Example PR Comment](images/pr_commenter.png)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Faquasecurity%2Ftfsec-pr-commenter-action","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Faquasecurity%2Ftfsec-pr-commenter-action","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Faquasecurity%2Ftfsec-pr-commenter-action/lists"}