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

Update ValidateFormatPlugin Documentation - additional options command #303

Closed
vincentclee opened this issue Sep 18, 2020 · 0 comments · Fixed by #305
Closed

Update ValidateFormatPlugin Documentation - additional options command #303

vincentclee opened this issue Sep 18, 2020 · 0 comments · Fixed by #305
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers
Milestone

Comments

@vincentclee
Copy link
Contributor

I noticed the command to enable additional options for the ValidateFormatPlugin are a bit different than what is described -
https://github.com/manheim/terraform-pipeline/blob/master/docs/ValidateFormatPlugin.md

Here are my recommendations

ValidateFormatPlugin.withRecursive()
                    .withDiff()
                    .init()

change to

TerraformFormatCommand.withRecursive()
                      .withDiff()
ValidateFormatPlugin.init()

Also, a few spelling points:

  • Additonal to Additional
  • recusively to recursively

🇺🇸

@kmanning kmanning added documentation Improvements or additions to documentation good first issue Good for newcomers labels Sep 18, 2020
@kmanning kmanning added this to the v5.12 milestone Sep 18, 2020
@kmanning kmanning linked a pull request Sep 23, 2020 that will close this issue
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants