check-suggested-spec.yml

name: Check suggested spec

on:
  issues:
    # Details for types below can be found at:
    # https://docs.github.com/en/webhooks-and-events/webhooks/webhook-events-and-payloads?actionType=edited#issues
    types:
      # Job triggered when an issue is created or re-opened
      - opened
      - reopened

      # or gets "edited" (title or body updated)
      - edited

jobs:
  check-spec:
    name: Check suggested spec
    runs-on: ubuntu-latest
    # We're only interested in "new spec" issues
    if: ${{ contains(github.event.issue.labels.*.name, 'new spec') }}
    steps:
      # Starting with Ubuntu 23+, a security feature prevents running Puppeteer
      # by default. It needs to be disabled. Using the "easiest" option, see:
      # https://chromium.googlesource.com/chromium/src/+/main/docs/security/apparmor-userns-restrictions.md
      # https://github.com/puppeteer/puppeteer/pull/13196/files
      - name: Disable AppArmor
        run: echo 0 | sudo tee /proc/sys/kernel/apparmor_restrict_unprivileged_userns

      - name: Setup node.js
        uses: actions/setup-node@v4
        with:
          node-version: 20

      - name: Checkout code
        uses: actions/checkout@v4
        with:
          ref: main

      - name: Install dependencies
        run: npm ci

      - name: Check suggested spec
        run: npx browser-specs build $NUMBER > res.md
        env:
          GITHUB_TOKEN: ${{ secrets.BOT_TOKEN }}
          NUMBER: ${{ github.event.issue.number }}

      # Report the result within a comment, using the `gh` command.
      # Unfortunately, the `--edit-last` option does not create a comment if
      # none exists. Ideally, we would check whether we created a comment first
      # and set/reset the option accordingly. To avoid creating more logic,
      # we'll just try the command with the option, and then without if that
      # fails. Note the nuance between "conclusion" and "outcome" in:
      # https://docs.github.com/en/actions/learn-github-actions/contexts#steps-context
      - name: Update last comment with result (if possible)
        id: update
        continue-on-error: true
        run: gh issue comment "$NUMBER" --body-file res.md --edit-last
        env:
          GITHUB_TOKEN: ${{ secrets.BOT_TOKEN }}
          NUMBER: ${{ github.event.issue.number }}

      - name: Add new comment with result (if none existed)
        if: ${{ steps.update.outcome == 'failure' }}
        run: gh issue comment "$NUMBER" --body-file res.md
        env:
          GITHUB_TOKEN: ${{ secrets.BOT_TOKEN }}
          NUMBER: ${{ github.event.issue.number }}