check-migrations.yml

name: Check Migrations

# If you modify more jobs, ensure that you add them as required to the job "confirmMigrationsPassed"
# which is located at the end of this file (more info in the job)

on:
  push:
    branches: ["main", "release-*"]
  pull_request:
  workflow_dispatch:

# Cancel a currently running workflow from the same PR, branch or tag when a new workflow is
# triggered (ref https://stackoverflow.com/a/72408109)
concurrency:
  group: ${{ github.workflow }}-${{ github.event.pull_request.number || github.ref }}
  cancel-in-progress: true

# drop permissions for default token
permissions: {}

jobs:
  # This generates a matrix with all the required jobs which will be run in the next step
  runtime-matrix:
    runs-on: ubuntu-latest
    outputs:
      runtime: ${{ steps.runtime.outputs.runtime }}
    name: Extract tasks from matrix
    steps:
      - uses: actions/checkout@v4
      - id: runtime
        run: |
          # Filter out runtimes that don't have a URI
          TASKS=$(jq '[.[] | select(.uri != null)]' .github/workflows/runtimes-matrix.json)
          SKIPPED_TASKS=$(jq '[.[] | select(.uri == null)]' .github/workflows/runtimes-matrix.json)
          echo --- Running the following tasks ---
          echo $TASKS
          echo --- Skipping the following tasks due to not having a uri field ---
          echo $SKIPPED_TASKS
          # Strip whitespace from Tasks now that we've logged it
          TASKS=$(echo $TASKS | jq -c .)
          echo "runtime=$TASKS" >> $GITHUB_OUTPUT

  # This runs all the jobs in the matrix. It is required by the "confirmMigrationsPassed" job, so
  # if they all pass, that job will pass too.
  check-migrations:
    needs: [runtime-matrix]
    continue-on-error: true
    runs-on: ubuntu-latest
    strategy:
      matrix:
        runtime: ${{ fromJSON(needs.runtime-matrix.outputs.runtime) }}
    steps:
      - name: Checkout sources
        uses: actions/checkout@v4

      - name: Build EXTRA_ARGS
        run: |
          # When running on relay, we don't need weight checks.
          EXTRA_FLAGS=""
          if [[ "${{ matrix.runtime.is_relay }}" == "true" ]]; then
            EXTRA_FLAGS+="--no-weight-warnings"
            echo "Disabling weight checks since we are on a relay"
          else
            echo "Enabling weight checks since we are not on a relay"
          fi

          # Disable the spec version check when we dont want to release.
          # The program prints either `1` or `0`.
          if [ "$(.github/changelog-processor.py CHANGELOG.md --should-release)" = "0" ]; then
            EXTRA_FLAGS+=" --disable-spec-version-check"
            echo "Disabling the spec version check since we are not releasing"
          else
            echo "Enabling the spec version check since we are releasing"
          fi

          echo "Flags: $EXTRA_FLAGS"

          echo "EXTRA_ARGS=$EXTRA_FLAGS" >> $GITHUB_ENV

      - name: Run ${{ matrix.runtime.name }} Runtime Checks
        uses: "paritytech/try-runtime-gha@v0.1.0"
        with:
          runtime-package: ${{ matrix.runtime.package }}
          node-uri: ${{ matrix.runtime.uri }}
          checks: "pre-and-post"
          extra-args: ${{ env.EXTRA_ARGS }}

  # This will only run if all the tests in its "needs" array passed.
  # Add this as your required job, becuase if the matrix changes size (new things get added)
  # it will still require all the steps to succeed.
  # If you add more jobs, remember to add them to the "needs" array.
  confirmMigrationsPassed:
    runs-on: ubuntu-latest
    name: All migrations passed
    # If any new job gets added, be sure to add it to this array
    needs: [check-migrations]
    steps:
      - run: echo '### Good job! All the migrations passed 🚀' >> $GITHUB_STEP_SUMMARY