feat: Add pre and post workflow hook status

[Fabianoshz]

Currently when a pre or post workflow hook is running there's no indication to the user. When running a lengthy task like using terragrunt-atlantis-config on a big repository a PR may stay a long time without any return.

This tries to help users (especially those with low experience) to identity the current status of the operation.

[Fabianoshz]

Still need to work on tests for this 😅

[nitrocode]

Nice job @Fabianoshz ! I'd love tests and I'd love to see the stdout output via the details link like we can for the terraform plan/applies.

[Fabianoshz]

Hi @nitrocode, I'll start writing tests for this, about the stdout output maybe on a separated PR? I'm still familiarizing myself with Atlantis code base.

[nitrocode]

A separate pr would be okay i suppose but in the mean time it would break consistency with what we currently have for the atlantis plan and apply workflows which do expose a details link. If you go the separate pr route, please do not forget to add and test that functionality or we may have to revert the pr.

Thoughts? @runatlantis/maintainers

[jamengual]

maybe keep it in the same PR since they will be related?

[nitrocode]

It would be nice too if the status of the pre and post workflows is modifiable like @albertorm95 is attempting in pr #2699. that pr will parae the output because the output is standard but in the case of pre and post workflows, there can be any script run, so it would be nice if we could set it to be a custom regex in the yaml to parse the output to bubble it up as the status. But of course this is just a bonus.

[Fabianoshz]

I'll look how to add stdout to the status link in this PR, I've messed around with the code base enough to fell confident about trying this. @nitrocode I will try to add a way of setting the status too, I'm unsure about the regex though, what do you think about passing an environment variable to the command, expecting the user to push the output it wants to the variable and then we expose it later? Regex might break in ways user might not expect, also it would be harder for them to test things.

[Fabianoshz]

@nitrocode Didn't managed to use a environment variable, instead I've passed an env with a filepath to the command so it can send the status to it. I just need to check the string size limit for this before sending it to the VCS client.

[Fabianoshz]

Ok, managed to make the output work, it will add the link to the check:

And will output the stdout to the UI:

Had to change a lot of things to make this work, and I have heavily coupled the hooks code to the functions that the jobs use to show the output too, I believe more changes will be required to make this more readable in the future, I think I'm gonna need more time to finish this.

Also the tests are broken (had to fix a bazillion times because I've kept changing things).

[Fabianoshz]

Custom descriptions seems to work fine too:

[GenPage]

Great PR, just some nitpicks.

[krrrr38]

nice work.

[jamengual]

@Fabianoshz when you have some time, resolve the discussions/feedback
otherwise it looks good to me

[nitrocode]

@runatlantis/maintainers ready for a second review 🙏

[krrrr38]

lgtm

[nitrocode]

@Fabianoshz nice job! This will be very helpful in the next release.

Thanks for the additional set of eyes @krrrr38 and @GenPage !

[ribejara-te]

Hey, this is a great feature. Thanks!