https://github.com/equisoft-devops/terraform-modules-lister

Github action to list all Terraform modules find in a directory to inject it on a markdown file.
https://github.com/equisoft-devops/terraform-modules-lister

github-actions terraform

Last synced: 7 months ago
JSON representation

Github action to list all Terraform modules find in a directory to inject it on a markdown file.

• Host: GitHub
• URL: https://github.com/equisoft-devops/terraform-modules-lister
• Owner: equisoft-devops
• License: mit
• Created: 2022-09-26T20:57:08.000Z (over 3 years ago)
• Default Branch: main
• Last Pushed: 2025-03-12T01:31:18.000Z (11 months ago)
• Last Synced: 2025-03-21T07:01:39.880Z (11 months ago)
• Topics: github-actions, terraform
• Language: Python
• Homepage:
• Size: 15.6 KB
• Stars: 3
• Watchers: 0
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE
  • Codeowners: CODEOWNERS

Awesome Lists containing this project

README

          
# terraform-modules-lister

List all modules in the repository and insert that on the markdown file.

## Example

```yaml

name: Generate terraform docs

on:

  pull_request:

    types: [opened, synchronize, reopened, ready_for_review]

jobs:

  docs:

    runs-on: ubuntu-latest

    steps:

    - uses: actions/checkout@v3

      with:

        fetch-depth: 0

        token: ${{ secrets.PAT }}

    - name: Terraform modules lister

      uses: equisoft-devops/terraform-modules-lister@v0.1.3

      with:

        find-dir: modules/

        output-file: README.md

    - uses: stefanzweifel/git-auto-commit-action@v4

      with:

        commit_message: "terraform-modules-lister: automated action"

```

This will insert the list of module into the README.md file between label `` and ``.

## Arguments

| Name        | Default     | Description                                                           |

| ----------- | ----------- | --------------------------------------------------------------------- |

| find-dir    | .           | Relative path to the base directory name where to find modules.       |

| output-file | README.md   | File name to insert the modules list                                  |

| tag-suffix  | MODULES     | Customize the label to search in the output-file. For example, AWS will search for `` and ``.|