Update previous comment when failure is resolved

[addepar-tg]

With the current behaviour of comment-summary-in-pr set to on-failure, a comment is made on failure and otherwise no comment is made. This is an awesome UX and we are using it currently.

However, when the failure is resolved and the action succeeds, the failure comment is still present and therefore still looks relevant to the developer. It would be great when comment-summary-in-pr is set to on-failure, any previous comment is marked as Resolved and therefore hidden from the developer. If the action fails again, a new comment should be created.

Thank you.

[febuiles]

Another case of inconsistent comment behavior: #628

[hannaustch]

Hello @febuiles, we've been facing the same issue but when comment-summary-in-pr equals to always. The comment is actually posted in the PR once only, on the first scan, and never updated or re-posted later. At the same time, I can see updated result summary inside Actions -> <security scan action run> -> Summary.

I agree with what have been commented before in both issues opened that the comment should be updated (ideally, removed/hidden and re-posted again) with every run (depending on the flag value set). For example:

• if comment-summary-in-pr is always: remove/hide comment and re-post with every new scan run
• if comment-summary-in-pr is on-failure: remove/hide comment when next scan is executed and re-post on the next failure
• and so on

Thank you!

[febuiles]

Thanks for the detailed feedback folks. We've been looking at ways to improve the experience with the comment/summary lately, and I think issue is something we can get sorted out soon. I don't have a timeframe to share, if you want to open a PR in the meantime I'd be happy to help.

/cc @jonjanego -- this is semi-related to the discussion and improvements you've been making in starter-workflows.