test-package.yml

name: Dart CI

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

env:
  PUB_ENVIRONMENT: bot.github

permissions: read-all

jobs:
  # Check code formatting with the dev SDK.
  format:
    runs-on: ubuntu-latest
    strategy:
      fail-fast: false
    steps:
      - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683
      - uses: dart-lang/setup-dart@e630b99d28a3b71860378cafdc2a067c71107f94
        with:
          sdk: dev
      - id: install
        name: Install dependencies
        run: dart pub get
      - name: Check formatting
        run: dart format --output=none --set-exit-if-changed .
        
  # Check static analysis against stable and dev SDKs.
  analyze:
    runs-on: ubuntu-latest
    strategy:
      fail-fast: false
      matrix:
        # TODO(srawlins): Re-enable stable Dart when 3.6.0 is available.
        #sdk: [3.5.0, dev]
        sdk: [dev]
    steps:
      - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683
      - uses: dart-lang/setup-dart@e630b99d28a3b71860378cafdc2a067c71107f94
        with:
          sdk: ${{ matrix.sdk }}
      - id: install
        name: Install dependencies
        run: dart pub get
      - name: Build generated artifacts
        run: dart pub run build_runner build
      - name: Analyze code
        run: dart analyze

  # Run tests against stable and dev SDKs.
  test:
    needs: analyze
    runs-on: ${{ matrix.os }}
    strategy:
      fail-fast: false
      matrix:
        os: [ubuntu-latest]
        # TODO(srawlins): Re-enable stable Dart when 3.6.0 is available.
        #sdk: [3.5.0, dev]
        sdk: [dev]
    steps:
      - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683
      - uses: dart-lang/setup-dart@e630b99d28a3b71860378cafdc2a067c71107f94
        with:
          sdk: ${{ matrix.sdk }}
      - id: install
        name: Install dependencies
        run: dart pub get
      - name: Run VM tests
        run: dart run build_runner test -- --platform vm
        if: always() && steps.install.outcome == 'success'
      - name: Run DDC build
        run: dart run build_runner build --fail-on-severe
        if: always() && steps.install.outcome == 'success'
      - name: Run DDC tests
        # We run with `--concurrency=1` because of a bug in the test package,
        # I believe: https://github.com/dart-lang/test/issues/2294. We can
        # look into removing this flag when we are using a version of the test
        # package without this bug.
        run: dart run build_runner test -- --platform chrome --concurrency=1
        if: always() && steps.install.outcome == 'success'

  document:
    needs: analyze
    runs-on: ${{ matrix.os }}
    strategy:
      fail-fast: false
      matrix:
        os: [ubuntu-latest]
    steps:
      - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683
      - uses: dart-lang/setup-dart@e630b99d28a3b71860378cafdc2a067c71107f94
        with:
          sdk: dev
      - id: install
        name: Install dependencies
        run: |
          dart pub get
          dart pub global activate dartdoc
      - name: Verify dartdoc
        run: dart pub global run dartdoc \
          --no-generate-docs \
          --errors=unresolved-doc-reference,ambiguous-doc-reference,ambiguous-reexport,broken-link,deprecated,no-library-level-docs,unknown-directive,unknown-macro
        if: always() && steps.install.outcome == 'success'