pr-reporter.yml

name: Report Results to PR

on:
  # The pull_request event can't write comments for PRs from forks so using this
  # workflow_run workflow as a workaround
  workflow_run:
    workflows: ['CI']
    types:
      - completed
      - requested

jobs:
  filter_jobs:
    name: Filter jobs
    runs-on: ubuntu-latest
    if: |
      github.event.workflow_run.event == 'pull_request'
    outputs:
      jsChanged: ${{ steps.filter.outputs.jsChanged }}
    steps:
      - uses: actions/checkout@v4
      - uses: dorny/paths-filter@v3
        id: filter
        with:
          # As this Workflow is triggered by a `workflow_run` event, the filter action
          # can't automatically assume we're working with PR data. As such, we need to
          # wire it up manually with a base (merge target) and ref (source branch).
          base: ${{ github.event.workflow_run.pull_requests[0].base.sha }}
          ref: ${{ github.event.workflow_run.pull_requests[0].head.sha }}
          # Should be kept in sync with the filter in the CI workflow
          predicate-quantifier: 'every'
          filters: |
            jsChanged:
              - '**/src/**/*.js'
              - '!devtools/src/devtools.js'

  report_running:
    name: Report benchmarks are in-progress
    needs: filter_jobs
    runs-on: ubuntu-latest
    # Only add the "benchmarks are running" text when a workflow_run is
    # requested (a.k.a starting)
    if: |
      needs.filter_jobs.outputs.jsChanged == 'true' &&
      github.event.action == 'requested'
    steps:
      - name: Report Tachometer Running
        uses: andrewiggins/tachometer-reporter-action@v2
        with:
          # Set initialize to true so this action just creates the comment or
          # adds the "benchmarks are running" text
          initialize: true

  report_results:
    name: Report benchmark results
    needs: filter_jobs
    runs-on: ubuntu-latest
    # Only run this job if the event action was "completed" and the triggering
    # workflow_run was successful
    if: |
      needs.filter_jobs.outputs.jsChanged == 'true' &&
      github.event.action == 'completed' &&
      github.event.workflow_run.conclusion == 'success'
    steps:
      # Download the artifact from the triggering workflow that contains the
      # Tachometer results to report
      - uses: dawidd6/action-download-artifact@v2
        with:
          workflow: ${{ github.event.workflow.id }}
          run_id: ${{ github.event.workflow_run.id }}
          name_is_regexp: true
          name: results-*
          path: results

      # Create/update the comment with the latest results
      - name: Report Tachometer Results
        uses: andrewiggins/tachometer-reporter-action@v2
        with:
          path: results/**/*.json
          base-bench-name: preact-main
          pr-bench-name: preact-local
          summarize: 'duration, usedJSHeapSize'