v3.0.0

3.0.0 (2023-11-20)

• Add a pull request comment with quick links to deploy with Riff-Raff (#85)

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

Note that GITHUB_TOKEN is provided by GitHub. See https://docs.github.com/en/actions/security-guides/automatic-token-authentication.