Add COMMENT_ARGS to Pre/Post-Workflow Hook Execution Environment #2621
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
This adds the
COMMENT_ARGS
environment variable to pre/post workflow hook execution environments, using the same escaping as for regular workflow steps.Use Case
At my workplace, we normally unlock projects after developers run
atlantis plan
since only operators can run applies in most environments (for compliance reasons) and this helps alleviate lock-contention issues. We do this using a post-workflow hook.However, there are some scenarios where we want to allow developers to conditionally keep their plans. My idea was to use
atlantis plan -- --keep-locks
and handle the logic in the post-workflow hook; however, that doesn't work because post-workflow hooks don't getCOMMENT_ARGS
. I also tried moving the unlocking step to a workflow step, but that fails to delete the plan files:So it seems I need to keep the unlocking logic in a post-workflow hook.