feat(post-workflow-hook): pass the result status of executed command to the post hook envs

[a1k0u]

what

The status of the result (whether there were any errors during execution) of the plan/apply command was added to the context and passed to the post workflow hook as an env for use in the shell script.

why

• We also use a post-hook to notify user of a completed plan/apply
• Knowing the completed status of the plan/apply command will help us to optimize transitions between the chat platform and VSC depending on the status

One of our post hook sends a notification to the engineer in Slack after the plan/apply command is completed (we have tools that match VCS and Slack users). This is very useful because user does not need to check with some interval whether the plan/apply is completed. And also it is very difficult to forget about a ready-made plan that blocks some part of the infrastructure, or about an apply that may be successful or unsuccessful.

It is useful to know the general status of the executed command. If the apply was successful, user can check the result without checking the status of the pull request, or the apply failed, user needs to check what happened very quickly, perhaps some error will be critical for the infrastructure. Similarly to a plan, a successful plan can be immediately sent to the team for review without leaving Slack, and a failed plan must be checked so as not to block others (rerun or unlock).

tests

• I have checked that the plan/apply runners set the result status to the context
• I have checked that RunPostHooks sets the status to the WorkflowHookCommandContext
• I have checked that PostWorkflowHookRunner sets the status as env

references

[X-Guardian]

Hi @a1k0u, can you also update the docs: https://github.com/runatlantis/atlantis/blob/main/runatlantis.io/docs/post-workflow-hooks.md

[a1k0u]

@X-Guardian, thanks! I've added info about new env

[X-Guardian]

Looks good @a1k0u. Thanks for this.