report.yml

# This workflow is the main workflow for regenerating the data needed for Bowtie's UI.
# It retests all of Bowtie's supported implementations, publishing the reports (and other auxiliary metadata) for use in the frontend.
name: Collect New Test Results

on:
  workflow_call:
    inputs:
      bowtie-version:
        type: string
        required: false
        default: ""
  workflow_dispatch:
  schedule:
    # Every 6 hours, at 15 past the hour
    - cron: "15 */6 * * *"

permissions:
  contents: read
  pages: write
  id-token: write

concurrency:
  group: "pages"
  cancel-in-progress: true

jobs:
  dialects:
    runs-on: ubuntu-latest
    outputs:
      dialects: ${{ steps.dialects-matrix.outputs.dialects }}
    steps:
      - uses: actions/checkout@v4
      - name: Collect supported dialects
        id: dialects-matrix
        run: |
          printf 'dialects=%s\n' "$(jq -c '[.[].shortName]' data/dialects.json)" >> $GITHUB_OUTPUT

  regenerate-reports:
    needs: dialects
    runs-on: ubuntu-latest
    strategy:
      fail-fast: false
      matrix:
        version: ${{ fromJson(needs.dialects.outputs.dialects) }}

    steps:
      - uses: actions/checkout@v4

      - name: Install Bowtie
        uses: ./
        with:
          version: ${{ inputs.bowtie-version }}

      - name: Generate a New Report
        run: |
          bowtie suite $(bowtie filter-implementations | sed 's/^/-i /') https://github.com/json-schema-org/JSON-Schema-Test-Suite/tree/main/tests/${{ matrix.version }} >${{ matrix.version }}.json

      # This is useful to debug whether Bowtie accidentally fetched some huge
      # number of container images.
      - name: Show what images we fetched
        run: docker images
        if: always()

        # FIXME: We ignore for now as now this exits unsuccessfully if there
        #        are *test* failures
      - name: Check Report is Valid
        run: |
          bowtie summary --show failures ${{ matrix.version }}.json --format markdown >> $GITHUB_STEP_SUMMARY
        continue-on-error: true

      - uses: actions/upload-artifact@v4
        with:
          name: report-${{ matrix.version }}
          path: ${{ matrix.version }}.json

  generate-implementation-metadata:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4

      - name: Install Bowtie
        uses: ./
        with:
          version: ${{ inputs.bowtie-version }}

      - name: Regenerate data needed by the UI
        run: |
          bowtie info $(bowtie filter-implementations | sed 's/^/-i /') --format json > implementations.json
      - uses: actions/upload-artifact@v4
        with:
          name: implementations
          path: implementations.json

      - name: Regenerate data for our public APIs
        run: |
          mkdir -p api/v1/json-schema-org
          bowtie filter-implementations | \
            while read -r impl; do
              bowtie info -i $impl --format json | \
              jq --arg impl "$impl" --slurpfile dialects data/dialects.json '
                . as $info |
                {($info.source): (
                  {
                    id: $impl,
                    dialects: $info.dialects,
                    badges_urls: (
                      {
                        supported_versions: "https://bowtie.report/badges/\($info.language)-\($info.name)/supported_versions.json",
                        compliance: (
                          $info.dialects | map(
                            . as $uri |
                            $dialects[0] | map(select(.uri == $uri)) | .[0] |
                            {
                              (.uri): "https://bowtie.report/badges/\($info.language)-\($info.name)/compliance/\(.shortName).json"
                            }
                          ) | add
                        )
                      }
                    )
                  }
                )}
              '
            done | \
          jq -s 'add' > api/v1/json-schema-org/implementations

      - name: Validate the public API data against their schema(s)
        run: |
          VALIDATION=$(bowtie validate --expect valid -i python-jsonschema bowtie/schemas/api/v1/json-schema-org/implementations.json api/v1/json-schema-org/implementations)
          echo "$VALIDATION" | bowtie summary --show failures --format markdown >> $GITHUB_STEP_SUMMARY

      - uses: actions/upload-artifact@v4
        with:
          name: api
          path: api

  site:
    needs:
      - regenerate-reports
      - generate-implementation-metadata

    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
      - name: Install Bowtie
        uses: ./
        with:
          version: ${{ inputs.bowtie-version }}

      - name: Create our Site Structure
        run: mkdir site

      - name: Include New Reports
        uses: actions/download-artifact@v4
        with:
          pattern: report-*
          path: site/
          merge-multiple: true

      - name: Include our UI data
        uses: actions/download-artifact@v4
        with:
          name: implementations
          path: site/
      - name: Include our public API data
        uses: actions/download-artifact@v4
        with:
          name: api
          path: site/api

      - name: Generate Badges
        run: bowtie badges

      - uses: actions/upload-artifact@v4
        with:
          name: site
          path: site

  redeploy-frontend:
    needs: site
    uses: ./.github/workflows/ui.yml
    with:
      report_artifact_in_scope: true