ci.yml

name: CI

on:
  push:
    branches: [main, develop]
  pull_request:
    branches: [main, develop]
  workflow_dispatch:

concurrency:
  group: ${{ github.workflow }}-${{ github.event.pull_request.number || github.ref }}
  cancel-in-progress: ${{ github.event_name == 'pull_request' }}

permissions:
  contents: read

env:
  CARGO_TERM_COLOR: always
  CARGO_PROFILE_DEV_DEBUG: line-tables-only
  CARGO_PROFILE_TEST_DEBUG: line-tables-only
  RUST_BACKTRACE: 1

jobs:
  workflow-lint:
    name: Workflow lint
    runs-on: ubuntu-latest
    steps:
      - name: Checkout repository
        uses: actions/checkout@v4

      - name: Validate GitHub Actions workflows
        uses: raven-actions/actionlint@3d39aea434753780c3b3d4a1a31c854b4dbf49d7 # v2.2.0
        with:
          version: 1.7.12

      - name: Verify README release version
        run: python3 scripts/readme_release.py --check

      - name: Test Discord release announcements
        run: python3 -m unittest tests.test_discord_release

      - name: Test validation helpers
        run: python3 -m unittest tests.test_doctest_packages tests.test_test_performance

  test:
    name: Test Suite (${{ matrix.platform.standard }}, ${{ matrix.rust }})
    runs-on: >-
      ${{
        (
          github.event_name != 'pull_request' ||
          github.event.pull_request.head.repo.full_name == github.repository
        ) && matrix.platform.warp || matrix.platform.standard
      }}
    timeout-minutes: 30
    strategy:
      fail-fast: false
      matrix:
        platform:
          - standard: ubuntu-latest
            warp: warp-ubuntu-latest-x64-32x
          - standard: macos-latest
            warp: warp-macos-latest-arm64-12x
          - standard: windows-latest
            warp: warp-windows-latest-x64-32x
        rust: [stable]
    steps:
      - name: Checkout repository
        uses: actions/checkout@v4

      - name: Install Rust toolchain
        uses: dtolnay/rust-toolchain@master
        with:
          toolchain: ${{ matrix.rust }}

      - name: Install ripgrep
        uses: ./.github/actions/install-ripgrep

      - name: Cache Rust build artifacts
        uses: Swatinem/rust-cache@v2
        with:
          shared-key: validation-${{ runner.os }}

      - name: Run tests
        run: cargo test --all-targets --all-features --verbose

      - name: Test platform keyboard decoder
        run: cargo test --locked --manifest-path vendor/crossterm/Cargo.toml --lib red_

      - name: Test terminal keyboard protocol
        if: runner.os != 'Windows'
        run: |
          cargo build --locked --bin red
          python3 scripts/test_keyboard_protocol.py

  clippy:
    name: Clippy (${{ matrix.os }})
    runs-on: ${{ matrix.os }}
    strategy:
      fail-fast: false
      matrix:
        os: ${{ github.event_name == 'pull_request' && fromJSON('["ubuntu-latest"]') || fromJSON('["ubuntu-latest", "macos-latest", "windows-latest"]') }}
    steps:
      - name: Checkout repository
        uses: actions/checkout@v4

      - name: Install Rust toolchain
        uses: dtolnay/rust-toolchain@stable
        with:
          components: clippy

      - name: Cache Rust build artifacts
        uses: Swatinem/rust-cache@v2
        with:
          shared-key: validation-${{ runner.os }}

      - name: Deny every Clippy warning
        run: cargo clippy --all-targets --all-features -- -D warnings

  fmt:
    name: Rustfmt
    runs-on: ubuntu-latest
    steps:
      - name: Checkout repository
        uses: actions/checkout@v4

      - name: Install Rust toolchain
        uses: dtolnay/rust-toolchain@stable
        with:
          components: rustfmt

      - name: Check formatting
        run: cargo fmt --all -- --check

  self-check:
    name: Bundled Runtime Self-Check
    runs-on: ubuntu-latest
    steps:
      - name: Checkout repository
        uses: actions/checkout@v4

      - name: Install Rust toolchain
        uses: dtolnay/rust-toolchain@stable

      - name: Cache Rust build artifacts
        uses: Swatinem/rust-cache@v2
        with:
          shared-key: validation-${{ runner.os }}

      - name: Initialize bundled runtime
        run: cargo run --locked -- --self-check

  changelog:
    name: Changelog
    runs-on: ubuntu-latest
    steps:
      - name: Checkout repository
        uses: actions/checkout@v4
        with:
          fetch-depth: 0

      - name: Validate git-cliff configuration
        uses: orhun/git-cliff-action@f50e11560dce63f7c33227798f90b924471a88b5
        with:
          version: v2.13.1
          config: cliff.toml
          args: --unreleased
        env:
          OUTPUT: changelog-preview.md

      - name: Validate GitHub release notes configuration
        uses: orhun/git-cliff-action@f50e11560dce63f7c33227798f90b924471a88b5
        with:
          version: v2.13.1
          config: cliff.release.toml
          args: --unreleased
        env:
          OUTPUT: release-notes-preview.md

      - name: Read release PR version
        if: startsWith(github.head_ref, 'release/v')
        id: release
        shell: bash
        env:
          HEAD_REF: ${{ github.head_ref }}
        run: echo "version=${HEAD_REF#release/v}" >> "$GITHUB_OUTPUT"

      - name: Regenerate release PR changelog
        if: startsWith(github.head_ref, 'release/v')
        uses: orhun/git-cliff-action@f50e11560dce63f7c33227798f90b924471a88b5
        with:
          version: v2.13.1
          config: cliff.toml
          args: --unreleased --tag v${{ steps.release.outputs.version }} --strip all
        env:
          OUTPUT: generated-release-changes.md

      - name: Verify release PR changelog
        if: startsWith(github.head_ref, 'release/v')
        shell: bash
        env:
          VERSION: ${{ steps.release.outputs.version }}
        run: |
          set -euo pipefail
          awk -v heading="## [$VERSION]" '
            index($0, heading) == 1 { found = 1 }
            found && /^## \[/ && index($0, heading) != 1 { exit }
            found { print }
          ' CHANGELOG.md > committed-release-changes.md
          test -s committed-release-changes.md
          normalize_markdown() {
            awk '
              NF {
                if (pending_blank && wrote) print ""
                print
                wrote = 1
                pending_blank = 0
                next
              }
              wrote { pending_blank = 1 }
            ' "$1"
          }
          normalize_markdown committed-release-changes.md > normalized-committed-release-changes.md
          normalize_markdown generated-release-changes.md > normalized-generated-release-changes.md
          diff -u normalized-committed-release-changes.md normalized-generated-release-changes.md

  build:
    name: Build
    if: github.event_name != 'pull_request'
    runs-on: ${{ matrix.os }}
    strategy:
      fail-fast: false
      matrix:
        os: [ubuntu-latest, macos-latest, windows-latest]
        include:
          - os: ubuntu-latest
            target: x86_64-unknown-linux-gnu
          - os: macos-latest
            target: x86_64-apple-darwin
          - os: windows-latest
            target: x86_64-pc-windows-msvc
    steps:
      - name: Checkout repository
        uses: actions/checkout@v4

      - name: Install Rust toolchain
        uses: dtolnay/rust-toolchain@stable
        with:
          targets: ${{ matrix.target }}

      - name: Cache Rust release build artifacts
        uses: Swatinem/rust-cache@v2
        with:
          shared-key: release-${{ matrix.target }}

      - name: Build release binary
        run: cargo build --release --target ${{ matrix.target }}

      - name: Upload artifacts
        uses: actions/upload-artifact@v4
        with:
          name: red-${{ matrix.target }}
          path: |
            target/${{ matrix.target }}/release/red
            target/${{ matrix.target }}/release/red.exe

  docs:
    name: Documentation
    runs-on: ubuntu-latest
    steps:
      - name: Checkout repository
        uses: actions/checkout@v4

      - name: Install Rust toolchain
        uses: dtolnay/rust-toolchain@stable

      - name: Cache Rust build artifacts
        uses: Swatinem/rust-cache@v2
        with:
          shared-key: validation-${{ runner.os }}

      - name: Build documentation and deny rustdoc warnings
        env:
          RUSTDOCFLAGS: -D warnings
        run: cargo doc --workspace --no-deps --all-features --document-private-items

      - name: Run documentation tests
        run: python3 scripts/doctest_packages.py --no-default-features

      - name: Check documentation links
        run: |
          python3 scripts/check_markdown_links.py --self-test
          python3 scripts/check_markdown_links.py