{"id":20185557,"url":"https://github.com/maur1th/tfdoc","last_synced_at":"2026-02-21T20:31:04.362Z","repository":{"id":34306287,"uuid":"176210742","full_name":"maur1th/tfdoc","owner":"maur1th","description":"Generate Terraform module documentation","archived":false,"fork":false,"pushed_at":"2023-01-19T23:43:04.000Z","size":37,"stargazers_count":2,"open_issues_count":1,"forks_count":1,"subscribers_count":0,"default_branch":"master","last_synced_at":"2025-09-15T13:53:01.544Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"HCL","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/maur1th.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}},"created_at":"2019-03-18T05:32:24.000Z","updated_at":"2023-08-28T11:47:48.000Z","dependencies_parsed_at":"2023-02-11T22:31:06.011Z","dependency_job_id":null,"html_url":"https://github.com/maur1th/tfdoc","commit_stats":null,"previous_names":[],"tags_count":6,"template":false,"template_full_name":null,"purl":"pkg:github/maur1th/tfdoc","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/maur1th%2Ftfdoc","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/maur1th%2Ftfdoc/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/maur1th%2Ftfdoc/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/maur1th%2Ftfdoc/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/maur1th","download_url":"https://codeload.github.com/maur1th/tfdoc/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/maur1th%2Ftfdoc/sbom","scorecard":{"id":628406,"data":{"date":"2025-08-11","repo":{"name":"github.com/maur1th/tfdoc","commit":"3ac45922199aee47163538ca03158053bcc9ac5a"},"scorecard":{"version":"v5.2.1-40-gf6ed084d","commit":"f6ed084d17c9236477efd66e5b258b9d4cc7b389"},"score":2.7,"checks":[{"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":"Token-Permissions","score":-1,"reason":"No tokens found","details":null,"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":"Code-Review","score":0,"reason":"Found 1/24 approved changesets -- score normalized to 0","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":-1,"reason":"no workflows found","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":"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":"Pinned-Dependencies","score":-1,"reason":"no dependencies found","details":null,"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":"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":"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":"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: Apache License 2.0: 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":"Signed-Releases","score":0,"reason":"Project has not signed or included provenance with any releases.","details":["Warn: release artifact v0.1.5 not signed: https://api.github.com/repos/maur1th/tfdoc/releases/16273354","Warn: release artifact v0.1.4 not signed: https://api.github.com/repos/maur1th/tfdoc/releases/16248815","Warn: release artifact v0.1.3 not signed: https://api.github.com/repos/maur1th/tfdoc/releases/16248766","Warn: release artifact v0.1.2 not signed: https://api.github.com/repos/maur1th/tfdoc/releases/16248653","Warn: release artifact v0.1.5 does not have provenance: https://api.github.com/repos/maur1th/tfdoc/releases/16273354","Warn: release artifact v0.1.4 does not have provenance: https://api.github.com/repos/maur1th/tfdoc/releases/16248815","Warn: release artifact v0.1.3 does not have provenance: https://api.github.com/repos/maur1th/tfdoc/releases/16248766","Warn: release artifact v0.1.2 does not have provenance: https://api.github.com/repos/maur1th/tfdoc/releases/16248653"],"documentation":{"short":"Determines if the project cryptographically signs release artifacts.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#signed-releases"}},{"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"}},{"name":"Branch-Protection","score":0,"reason":"branch protection not enabled on development/release branches","details":["Warn: branch protection not enabled for branch 'master'"],"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":"SAST","score":0,"reason":"SAST tool is not run on all commits -- score normalized to 0","details":["Warn: 0 commits out of 7 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"}}]},"last_synced_at":"2025-08-21T07:10:39.042Z","repository_id":34306287,"created_at":"2025-08-21T07:10:39.042Z","updated_at":"2025-08-21T07:10:39.042Z"},"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":29692521,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-02-21T18:18:25.093Z","status":"ssl_error","status_checked_at":"2026-02-21T18:18:22.435Z","response_time":107,"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-14T03:13:52.051Z","updated_at":"2026-02-21T20:31:04.347Z","avatar_url":"https://github.com/maur1th.png","language":"HCL","funding_links":[],"categories":[],"sub_categories":[],"readme":"# tfdoc\n\nThis project aims at generating Terraform module documentation.\n\n## Usage\n\ntfdoc will parse all the files within a module's directory and generate markdown code accordingly:\n\n```tf\n# Title: The name of the module\n# Top comment prefixed by \"Title: \" and the following lines\n# will be at the top of the Markdown file\n\nvariable \"environment\" {\n  description = \"Variable descriptions will be parsed\"\n}\n\n# tfdoc keeps comments right on top of resource, variable\n# and output blocks. All variables and outputs are kept.\n# Only resources with comments on top are.\nresource \"aws_instance\" \"this\" {\n  # stuff\n}\n\nresource \"aws_instance\" \"no_comment_here\" {\n  # stuff\n}\n\n##\n## tfdoc discards other \"orphaned\" comments\n##\n\n# We can have both comments on top\noutput \"name\" {\n  description = \"and within outputs and variables\"\n}\n\n# Data blocks are ignored\ndata \"aws_ami\" \"node\" {}\n```\n\n```sh\n$ tfdoc $PATH_TO_MODULE\n# The name of the module\n\nTop comment prefixed by \"Title: \" and the following lines will be at the top of the Markdown file\n\n## Resources\n\n* `aws_instance.this`: tfdoc keeps comments right on top of resource, variable and output blocks. All variables and outputs are kept. Only resources with comments on top are.\n\n## Inputs\n\n* `environment`: Variable descriptions will be parsed\n\n## Outputs\n\n* `name`: We can have both comments on top and within outputs and variables\n```\n\nYou can supply the `-t` parameter thusly `tfdoc -t $PATH_TO_MODULE` and get the output in table form rather than list form.\n\nOriginal idea by \u003chttps://github.com/jyrivallan\u003e\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmaur1th%2Ftfdoc","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmaur1th%2Ftfdoc","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmaur1th%2Ftfdoc/lists"}