feat!: Add comment to PR

[akash1810]

What does this change?

In #20 a job summary was added with Riff-Raff information.

This change takes this a little further, adding a comment to the pull request with links to deploy the project in Riff-Raff. Only one comment will be made. As new builds are created, the comment is updated.

This change adds two new inputs:

• (required) githubToken is a GitHub token with permissions to comment on a pull request.
• (optional) commentingStage which stage to deploy to. Default of CODE.

How to test

Use the action!

• ci: Update guardian/actions-riff-raff to get PR comments service-catalogue#487 would be a typical usage, only setting githubToken.
• ci: Update guardian/actions-riff-raff to get PR comments cdk-playground#399 sets commentingStage to PROD as the app only has one stage.

Have we considered potential risks?

This should be released as a breaking change as a new required input githubToken is added.

Images

Draft release notes

v3.0.0

• Add a pull request comment with quick links to deploy with Riff-Raff

BREAKING CHANGES

A new required input githubToken has been added. This needs to be scoped with pull-requests: write permission.

Before (v2)

jobs:
  CI:
    timeout-minutes: 15
    runs-on: ubuntu-latest
    steps:
      - uses: guardian/actions-riff-raff@v2
        with:
          projectName: playground::my-application
          configPath: riff-raff.yaml
          contentDirectories: |
            static-site-assets:
              - static-site/dist
            api:
              - target/application.jar

After (v3)

jobs:
  CI:
    timeout-minutes: 15
    runs-on: ubuntu-latest
    permissions: 
      pull-requests: write # <- NEW!
    steps:
      - uses: guardian/actions-riff-raff@v3 # Note the version change
        with:
          githubToken: ${{ secrets.GITHUB_TOKEN }} # <- NEW!
          projectName: playground::my-application
          configPath: riff-raff.yaml
          contentDirectories: |
            static-site-assets:
              - static-site/dist
            api:
              - target/application.jar

[akash1810]

This is used to locate a previous comment to update.

[akash1810]

I'm not convinced this is the best variable name. Alternatives welcomed!

[rtyley]

Only one comment will be made. As new builds are created, the comment is updated.

@akash1810 is this still intended to be the case? Unfortunately it doesn't seem to be working with the recent PRs I've seen. For instance, in this PR: https://github.com/guardian/ophan/pull/6106, there are 8 comments made by actions-riff-raff:

• Deploy build 23997 of ophan:dashboard-es7-arm to CODE
• Deploy build 23997 of ophan:the-slab to CODE
• Deploy build 23997 of ophan:big-loader-es7-arm to CODE
• etc

It's quite noisy- this happens on every single PR on Ophan - and it would be great if all these could be in the same comment, rather than 8 separate comments!

[akash1810]

@rtyley the action is behaving as intended - a comment is added for each Riff-Raff project an artifact has been built for. In the case of Ophan, there are 8 unique projects being built, hence 8 comments.

Folding this into a single comment sounds great! Indeed it has come up previously.

Looking at https://github.com/guardian/riffraff-platform/blob/main/packages/common/src/access.ts, there are quite a few repositories that produce more than 1 artifact, which could help prioritise implementing this.

Let's create an issue for this?