Approving review comments don't trigger plans

[r-bennett]

Leaving an approving review (rather than a comment review) with plan doesn't trigger the plan.

Ideally I think an approving review should have the same effect as a plan comment, regardless of whether it contains plan in the review comment - if it's good enough for master it's good enough for a speculative plan. It's quite common that people approve the config without knowing they need to add a plan comment too, which creates an extra pain point getting these PRs through the pipeline

[jgiannuzzi]

Hi @r-bennett, tfe-plan-bot does support this workflow — it just needs to be configured that way by enabling options.methods.github_review in your approval rule.

The one thing to pay attention to is that people may approve changes that would not run properly, which we may want to discourage, but again this is all a matter of workflow and configuration.

[r-bennett]

Perfect, thanks very much!

[r-bennett]

Thinking about it, this is probably still a bug/unexpected behaviour - if you're configured to have a "plan" comment only to unblock the plan, I'd expect it to still work if a user left an approving review with a "plan" comment as part of it, i.e.

Enabling options.methods.github_review is definitely going to cover this for my use-case though so I'm happy 😄

[jgiannuzzi]

I added support for review comments to policy-bot (whose engine is used by tfe-plan-bot) in palantir/policy-bot#257, but left review approvals explicitly out, as approvals are driven by options.methods.github_review.

I noticed that options.methods.github_review_comment_patterns has been added in palantir/policy-bot#361. Upgrading tfe-plan-bot to use policy-bot v1.24.0 would enable running the plan when a specific comment is written in a review approval.