Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

output-format overriding config file #104

Open
jkrilov opened this issue Feb 20, 2023 · 0 comments
Open

output-format overriding config file #104

jkrilov opened this issue Feb 20, 2023 · 0 comments
Labels
bug Something isn't working

Comments

@jkrilov
Copy link

jkrilov commented Feb 20, 2023

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

@jkrilov jkrilov added the bug Something isn't working label Feb 20, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working
Projects
None yet
Development

No branches or pull requests

1 participant