search

terraform-docs / gh-actions

A Github action for generating Terraform module documentation using terraform-docs and gomplate
Apache License 2.0
152 stars 63 forks source link

output-format overriding config file #104

Open jkrilov opened 1 year ago

jkrilov commented 1 year ago

Describe the bug

Specifying a value for output-format or even not specifying it and using the default markdown table overrides the formatter specified in the config file.

How can we reproduce it?

Create a config file with a formatter other than markdown table. Then run the following Action:

    - name: Render terraform docs inside the README.md and push changes back to PR branch
      uses: terraform-docs/gh-actions@main
      with:
        working-dir: ./terraform
        config-file: ".terraform-docs.yml"
        git-push: "true"

The output will default to markdown table regardless of what is specified in the config file

Environment information

Github Actions with Ubuntu-Latest image