test.yml

name: test

on:
  # Run on PRs and pushes to the default branch.
  push:
    branches:
      - main
  pull_request:
    branches:
      - main
  schedule:
    - cron: "0 0 * * 0"

# Declare default permissions as read only.
permissions: read-all

env:
  # Keep for Dart SDK reporting
  PUB_ENVIRONMENT: bot.github
  # LTS
  NODE_VERSION: '20'
  # Tool location
  BASE_DIR: ${{ github.workspace }}
  TOOL_DIR: ${{ github.workspace }}/tool

jobs:
  test:
    name: Analyze and test code examples
    runs-on: ubuntu-latest
    strategy:
      fail-fast: false
      matrix:
        include:
          - sdk: beta
            experimental: false
          - sdk: stable
            experimental: false
    continue-on-error: ${{ matrix.experimental }}
    steps:
      - uses: actions/checkout@44c2b7a8a4ea60a981eaca3cf939b5f4305c123b
        with:
          submodules: recursive
      - uses: dart-lang/setup-dart@f0ead981b4d9a35b37f30d36160575d60931ec30
        with:
          sdk: ${{ matrix.sdk }}
      - name: Fetch Dart packages
        run: dart pub get
      - name: Check Dart code formatting
        run: dart run dart_site format-dart --check
      - name: Analyze Dart code
        run: dart run dart_site analyze-dart
      - name: Run Dart tests
        run: dart run dart_site test-dart

  excerpts:
    name: Check if code excerpts are up to date
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@44c2b7a8a4ea60a981eaca3cf939b5f4305c123b
        with:
          submodules: recursive
      - uses: dart-lang/setup-dart@f0ead981b4d9a35b37f30d36160575d60931ec30
        with:
          sdk: stable
      - name: Fetch Dart packages
        run: dart pub get
      - name: Check if excerpts are up to date
        run: dart run dart_site refresh-excerpts --fail-on-update --dry-run

  linkcheck:
    name: Build site and check links
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@44c2b7a8a4ea60a981eaca3cf939b5f4305c123b
        with:
          submodules: recursive
      - uses: dart-lang/setup-dart@f0ead981b4d9a35b37f30d36160575d60931ec30
        with:
          sdk: stable
      - name: Fetch Dart packages
        run: dart pub get
      - uses: pnpm/action-setup@a3252b78c470c02df07e9d59298aecedc3ccdd6d
        with:
          version: 8
      - uses: actions/setup-node@60edb5dd545a775178f52524783378180af0d1f8
        with:
          node-version: ${{ env.NODE_VERSION }}
          cache: 'pnpm'
      - name: Install node dependencies
        run: pnpm install
      - name: Build site
        run: dart run dart_site build
      - name: Check for broken Markdown links
        run: dart run dart_site check-link-references
      - name: Check internal site links are functional
        run: dart run dart_site check-links

  site-variable-scanner:
    name: Check if text can be replaced with site variables
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@44c2b7a8a4ea60a981eaca3cf939b5f4305c123b
        with:
          submodules: recursive
      - uses: dart-lang/setup-dart@f0ead981b4d9a35b37f30d36160575d60931ec30
        with:
          sdk: stable
      - name: Fetch Dart packages
        run: dart pub get
      - name: Check if text can be replaced with site variables
        run: dart run dart_site check-site-variable

  firebase-validate:
    name: Validate Firebase configuration
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@44c2b7a8a4ea60a981eaca3cf939b5f4305c123b
        with:
          submodules: recursive
      - uses: dart-lang/setup-dart@f0ead981b4d9a35b37f30d36160575d60931ec30
        with:
          sdk: stable
      - name: Fetch Dart packages
        run: dart pub get
      - name: Validate the firebase.json file
        run: dart run dart_site verify-firebase-json