Change review apps PR workflow to leave only one comment

[lfdebrux]

What problem does this pull request solve?

The way we work with GitHub in this repo means we need to rebase our PRs often; this on top of the usual back and forth when reviewing means that review apps might get deployed several times before a PR is merged. This is fine, except that every time the review apps are deployed there is a new comment left by the workflow, which is a bit noisy.

This PR changes the workflow to first delete any existing comments about review apps (similar to what our other sonarqube cloud bot does), so that there should only be one comment about review apps on a PR at a time, but it keeps its useful place in the timeline.

Things to consider when reviewing

• Ensure that you consider the wider context.
• Does it work when run on your machine?
• Is it clear what the code is doing?
• Do the commit messages explain why the changes were made?
• Are there all the unit tests needed?
• Has all relevant documentation been updated?

[AP-Hunt]

It's interesting that you thought of this too. Sarah and I thought about it as we built this and concluded "if it's needed it'll become evident".

The failing deployment is a permissions issue I need to fix from the forms-deploy side

[AP-Hunt]

This script isn't quite working, evidenced by the (currently!) two comments in this thread. I ran the script through Shellcheck and it pointed out why

old_comment_ids=$(gh api "repos/{owner}/{repo}/issues/${{github.event.pull_request.number}}/comments" --jq 'map(select((.user.login == "github-actions[bot]") and (.body | endswith($ENV.COMMENT_MARKER)))) | .[].id')
                                                                                                           ^-- SC2016: Expressions don't expand in single quotes, use double quotes for that.

For more information:
  https://www.shellcheck.net/wiki/SC2016 -- Expressions don't expand in singl...

If you want an env var available in a JQ expression you should do.

jq --arg name "${ENV_VAR}" 'expression using $name' input.json

Shellcheck says to use double quotes, but we generally avoid double quotes around JQ expressions because of the frequency with which we use double quotes in them.

[lfdebrux]

This script isn't quite working, evidenced by the (currently!) two comments in this thread. I ran the script through Shellcheck and it pointed out why

old_comment_ids=$(gh api "repos/{owner}/{repo}/issues/${{github.event.pull_request.number}}/comments" --jq 'map(select((.user.login == "github-actions[bot]") and (.body | endswith($ENV.COMMENT_MARKER)))) | .[].id')
                                                                                                           ^-- SC2016: Expressions don't expand in single quotes, use double quotes for that.

For more information:
  https://www.shellcheck.net/wiki/SC2016 -- Expressions don't expand in singl...

If you want an env var available in a JQ expression you should do.

jq --arg name "${ENV_VAR}" 'expression using $name' input.json

Shellcheck says to use double quotes, but we generally avoid double quotes around JQ expressions because of the frequency with which we use double quotes in them.

That's weird, it was working before 🤔

[AP-Hunt]

Looking at $ENV.COMMENT_MARKER were you perhaps using GitHub Actions interpolation before? That would be ${{env.COMMENT_MARKER}}. $ENV. isn't valid syntax for env vars in a POSIX shell afaik

[lfdebrux]

Looking at $ENV.COMMENT_MARKER were you perhaps using GitHub Actions interpolation before? That would be ${{env.COMMENT_MARKER}}. $ENV. isn't valid syntax for env vars in a POSIX shell afaik

I was trying to use the special $ENV variable in jq (https://jqlang.org/manual/#$env-env), rather than do a parameter expansion. Is there any reason not to do that?

[AP-Hunt]

None at all. I wasn't aware that existed!

[sonarqubecloud]

Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud

[github-actions]

🎉 A review copy of this PR has been deployed! You can reach it at https://pr-1804.review.forms.service.gov.uk/.

It may take 5 minutes or so for the application to be fully deployed and working. If it still isn't ready
after 5 minutes, there may be something wrong with the ECS task. You will need to go to the integration AWS account
to debug, or otherwise ask an infrastructure person.

For more details please see the review app wiki page

[lfdebrux]

@AP-Hunt fixed now (I was missing a newline)

[AP-Hunt]

Nice one! I can see there's only one comments from the bot now.