microsoft / azure-pipelines-terraform

Azure Pipelines tasks for installing Terraform and running Terraform commands in a build or release pipeline.
MIT License
95 stars 59 forks source link

Undocumented fileName parameter and -out requirement for plan command #195

Open mloskot opened 8 months ago

mloskot commented 8 months ago

In https://github.com/microsoft/azure-pipelines-terraform/issues/117#issuecomment-1342795831 @mericstam explains that

for V3 you need to do plan with commandoptions: -out

and

presents example with outputTo and fileName use for command: show.

These are not documented in the TerraformTaskV3/README.md.

A reader may expect to be able to use outputTo and fileName for command: plan too, and not sticking -out to commandOptions In other words, a reader may expect unified interface of all TerraformTaskV3 commands, and rightly so, but apparently that is not the case. IMHO, documentation is unclear there.

mericstam commented 8 months ago

Hi, I agree docs are a bit unclear. I have planned to redo the docs. trying to fit it into my schedule