runatlantis / atlantis

Terraform Pull Request Automation
https://www.runatlantis.io
Other
7.82k stars 1.06k forks source link

Improve documentation on pre-workflow hooks #1711

Open david-heward-unmind opened 3 years ago

david-heward-unmind commented 3 years ago

I'd really like to see some more detailed documentation about how the behaviour of these hooks actually works.

On several occasions whilst running a proof of concept of Atlantis I found that the docs were lacking in depth.

I would like to know more about how the hooks behave with regards to parallel execs and auto-generated workspaces. Also under what circumstances the hooks are run/re-run? Often we made changes to the config whilst testing a PR, only to see that not take effect.

david-heward-unmind commented 3 years ago

Upon some further digging, I stumbled across #1347

This is more or less the same reasoning as my own.

Essentially pre-workflow hooks when used to generate any tmp file in the checkout dir is frivolous & I assume must therefore then be moved into a custom workflow step instead.