{"id":23316883,"url":"https://github.com/equisoft-devops/terraform-modules-lister","last_synced_at":"2025-08-01T02:15:27.188Z","repository":{"id":65159678,"uuid":"541781163","full_name":"equisoft-devops/terraform-modules-lister","owner":"equisoft-devops","description":"Github action to list all Terraform modules find in a directory to inject it on a markdown file.","archived":false,"fork":false,"pushed_at":"2025-03-12T01:31:18.000Z","size":16,"stargazers_count":3,"open_issues_count":1,"forks_count":0,"subscribers_count":0,"default_branch":"main","last_synced_at":"2025-03-21T07:01:39.880Z","etag":null,"topics":["github-actions","terraform"],"latest_commit_sha":null,"homepage":"","language":"Python","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/equisoft-devops.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":"CODEOWNERS","security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2022-09-26T20:57:08.000Z","updated_at":"2025-03-12T01:31:22.000Z","dependencies_parsed_at":"2024-02-13T16:43:39.156Z","dependency_job_id":null,"html_url":"https://github.com/equisoft-devops/terraform-modules-lister","commit_stats":{"total_commits":7,"total_committers":1,"mean_commits":7.0,"dds":0.0,"last_synced_commit":"1271d64b362a897ed032fd664440e897931d649b"},"previous_names":[],"tags_count":8,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/equisoft-devops%2Fterraform-modules-lister","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/equisoft-devops%2Fterraform-modules-lister/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/equisoft-devops%2Fterraform-modules-lister/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/equisoft-devops%2Fterraform-modules-lister/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/equisoft-devops","download_url":"https://codeload.github.com/equisoft-devops/terraform-modules-lister/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247589835,"owners_count":20963022,"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","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-actions","terraform"],"created_at":"2024-12-20T16:16:54.968Z","updated_at":"2025-04-07T03:52:56.904Z","avatar_url":"https://github.com/equisoft-devops.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# terraform-modules-lister\n\nList all modules in the repository and insert that on the markdown file.\n\n## Example\n\n```yaml\nname: Generate terraform docs\n\non:\n  pull_request:\n    types: [opened, synchronize, reopened, ready_for_review]\n\njobs:\n  docs:\n    runs-on: ubuntu-latest\n    steps:\n    - uses: actions/checkout@v3\n      with:\n        fetch-depth: 0\n        token: ${{ secrets.PAT }}\n    - name: Terraform modules lister\n      uses: equisoft-devops/terraform-modules-lister@v0.1.3\n      with:\n        find-dir: modules/\n        output-file: README.md\n    - uses: stefanzweifel/git-auto-commit-action@v4\n      with:\n        commit_message: \"terraform-modules-lister: automated action\"\n```\n\nThis will insert the list of module into the README.md file between label `\u003c!-- BEGIN_TF_MODULES --\u003e` and `\u003c!-- END_TF_MODULES --\u003e`.\n\n## Arguments\n\n| Name        | Default     | Description                                                           |\n| ----------- | ----------- | --------------------------------------------------------------------- |\n| find-dir    | .           | Relative path to the base directory name where to find modules.       |\n| output-file | README.md   | File name to insert the modules list                                  |\n| tag-suffix  | MODULES     | Customize the label to search in the output-file. For example, AWS will search for `\u003c!-- BEGIN_TF_AWS --\u003e` and `\u003c!-- END_TF_AWS --\u003e`.|\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fequisoft-devops%2Fterraform-modules-lister","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fequisoft-devops%2Fterraform-modules-lister","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fequisoft-devops%2Fterraform-modules-lister/lists"}