ci.yml

name: CI

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

jobs:
  typst:
    name: Typst documents (${{ matrix.profile }}, Ubuntu)
    runs-on: ubuntu-latest
    strategy:
      fail-fast: false
      matrix:
        profile: [debug, release]
    timeout-minutes: 45
    permissions:
      contents: read
    env:
      PYTHONUTF8: '1'
      CARGO_INCREMENTAL: '0'

    steps:
    - name: Checkout repository
      uses: actions/checkout@v4

    - name: Checkout pinned Typst reporter
      uses: actions/checkout@v4
      with:
        repository: LDemetrios/typst-shared-library
        # cargo-jvm-experiment revision used to reproduce issue #61.
        ref: 55b485f923034f90792cb065ee68bf9f5856bdeb
        path: target/typst/source
        persist-credentials: false

    - name: Set up Python
      uses: actions/setup-python@v5
      with:
        python-version: '3.x'

    - name: Read pinned Rust toolchain
      id: rust-toolchain
      shell: bash
      run: |
        python - <<'PY'
        import os, tomllib
        with open("rust-toolchain.toml", "rb") as file:
            toolchain = tomllib.load(file)["toolchain"]
        with open(os.environ["GITHUB_OUTPUT"], "a", encoding="utf-8") as output:
            output.write(f"channel={toolchain['channel']}\n")
            output.write(f"components={','.join(toolchain.get('components', []))}\n")
        PY

    - name: Set up pinned Rust
      uses: dtolnay/rust-toolchain@stable
      with:
        toolchain: ${{ steps.rust-toolchain.outputs.channel }}
        components: ${{ steps.rust-toolchain.outputs.components }}

    - name: Set up Java
      uses: actions/setup-java@v4
      with:
        distribution: temurin
        java-version: '25'

    - name: Cache Cargo dependencies
      uses: Swatinem/rust-cache@v2
      with:
        shared-key: typst
        cache-targets: false

    - name: Build backend and tools
      run: python build.py ci

    - name: Compile and render Typst documents
      run: python tests/typst/run.py ${{ matrix.profile == 'release' && '--release' || '' }}

    - name: Upload Typst output and diagnostics
      if: always()
      uses: actions/upload-artifact@v4
      with:
        name: typst-documents-${{ matrix.profile }}
        path: target/typst/reports/
        if-no-files-found: warn

  self-tests:
    name: self-tests (${{ matrix.name }})
    runs-on: ${{ matrix.os }}
    strategy:
      fail-fast: false
      matrix:
        include:
          - name: Ubuntu
            os: ubuntu-latest
          - name: Windows
            os: windows-latest
    env:
      PYTHONUTF8: '1'

    steps:
    - name: Enable Git symlinks on Windows
      if: runner.os == 'Windows'
      shell: pwsh
      run: git config --global core.symlinks true

    - name: Checkout repository
      uses: actions/checkout@v4

    - name: Set up Python
      uses: actions/setup-python@v5
      with:
        python-version: '3.x'

    - name: Read pinned Rust toolchain
      id: rust-toolchain
      shell: bash
      run: |
        python - <<'PY'
        import os, tomllib
        with open("rust-toolchain.toml", "rb") as file:
            toolchain = tomllib.load(file)["toolchain"]
        with open(os.environ["GITHUB_OUTPUT"], "a", encoding="utf-8") as output:
            output.write(f"channel={toolchain['channel']}\n")
            output.write(f"components={','.join(toolchain.get('components', []))}\n")
        PY

    - name: Set up pinned Rust
      uses: dtolnay/rust-toolchain@stable
      with:
        toolchain: ${{ steps.rust-toolchain.outputs.channel }}
        components: ${{ steps.rust-toolchain.outputs.components }}

    - name: Set up Java
      uses: actions/setup-java@v4
      with:
        distribution: 'temurin'
        java-version: '25'

    - name: Set up Kotlin
      run: python tests/kotlin/install_kotlin.py --github-path

    - name: Cache Cargo dependencies
      uses: Swatinem/rust-cache@v2
      with:
        # Older caches contain source overlays that the action treats as build artifacts.
        prefix-key: self-tests-artifacts-v1

    - name: Build backend and tools
      run: python build.py ci

    - name: Run compiler unit tests
      id: compiler_unit_tests
      continue-on-error: true
      shell: bash
      run: |
        cargo test
        cargo test --manifest-path compiler-core/Cargo.toml
        cargo test --manifest-path java-linker/Cargo.toml

    - name: Check JVM binding macros
      id: jvm_macro_tests
      continue-on-error: true
      shell: bash
      run: |
        cargo fmt --manifest-path jvm/Cargo.toml --check
        cargo test --manifest-path jvm/Cargo.toml

    - name: Run self-tests (debug)
      id: self_tests_debug
      continue-on-error: true
      run: python Tester.py

    - name: Run self-tests (release)
      id: self_tests_release
      continue-on-error: true
      run: python Tester.py --release

    - name: Remove generated sources before caching build artifacts
      if: always()
      run: python -c "from pathlib import Path; import shutil; p = Path('target/stdlib-overlay'); p.exists() and shutil.rmtree(p)"

    - name: Require 100% self-test pass rate
      if: >-
        always() &&
        (
          steps.compiler_unit_tests.outcome != 'success' ||
          steps.jvm_macro_tests.outcome != 'success' ||
          steps.self_tests_debug.outcome != 'success' ||
          steps.self_tests_release.outcome != 'success'
        )
      run: python -c "raise SystemExit('compiler, macro, debug, and release tests must pass completely')"

  coretests:
    name: coretests (Ubuntu)
    runs-on: ubuntu-latest
    timeout-minutes: 360
    env:
      PYTHONUTF8: '1'

    steps:
    - name: Checkout repository
      uses: actions/checkout@v4

    - name: Set up Python
      uses: actions/setup-python@v5
      with:
        python-version: '3.x'

    - name: Read pinned Rust toolchain
      id: rust-toolchain
      shell: bash
      run: |
        python - <<'PY'
        import os, tomllib
        with open("rust-toolchain.toml", "rb") as file:
            toolchain = tomllib.load(file)["toolchain"]
        with open(os.environ["GITHUB_OUTPUT"], "a", encoding="utf-8") as output:
            output.write(f"channel={toolchain['channel']}\n")
            output.write(f"components={','.join(toolchain.get('components', []))}\n")
        PY

    - name: Set up pinned Rust
      uses: dtolnay/rust-toolchain@stable
      with:
        toolchain: ${{ steps.rust-toolchain.outputs.channel }}
        components: ${{ steps.rust-toolchain.outputs.components }}

    - name: Set up Java
      uses: actions/setup-java@v4
      with:
        distribution: temurin
        java-version: '25'

    - name: Cache Cargo dependencies
      uses: Swatinem/rust-cache@v2

    - name: Build backend and tools
      run: python build.py ci

    - name: Run coretests (debug)
      id: coretests_debug
      continue-on-error: true
      run: python Coretests.py --timeout 20 --build-timeout 1200

    - name: Run coretests (release)
      id: coretests_release
      continue-on-error: true
      run: python Coretests.py --release --timeout 20 --build-timeout 1200

    - name: Upload coretests reports
      if: always()
      uses: actions/upload-artifact@v4
      with:
        name: coretests
        path: |
          target/coretests/reports/
          target/coretests/logs/
        if-no-files-found: error

    - name: Require 100% coretests pass rate
      if: >-
        always() &&
        (
          steps.coretests_debug.outcome != 'success' ||
          steps.coretests_release.outcome != 'success'
        )
      run: python -c "raise SystemExit('debug and release coretests must both pass completely')"

  alloctests:
    name: alloctests (Ubuntu)
    runs-on: ubuntu-latest
    timeout-minutes: 360
    env:
      PYTHONUTF8: '1'

    steps:
    - name: Checkout repository
      uses: actions/checkout@v4

    - name: Set up Python
      uses: actions/setup-python@v5
      with:
        python-version: '3.x'

    - name: Read pinned Rust toolchain
      id: rust-toolchain
      shell: bash
      run: |
        python - <<'PY'
        import os, tomllib
        with open("rust-toolchain.toml", "rb") as file:
            toolchain = tomllib.load(file)["toolchain"]
        with open(os.environ["GITHUB_OUTPUT"], "a", encoding="utf-8") as output:
            output.write(f"channel={toolchain['channel']}\n")
            output.write(f"components={','.join(toolchain.get('components', []))}\n")
        PY

    - name: Set up pinned Rust
      uses: dtolnay/rust-toolchain@stable
      with:
        toolchain: ${{ steps.rust-toolchain.outputs.channel }}
        components: ${{ steps.rust-toolchain.outputs.components }}

    - name: Set up Java
      uses: actions/setup-java@v4
      with:
        distribution: temurin
        java-version: '25'

    - name: Cache Cargo dependencies
      uses: Swatinem/rust-cache@v2

    - name: Build backend and tools
      run: python build.py ci

    - name: Run alloctests (debug)
      id: alloctests_debug
      continue-on-error: true
      run: python Alloctests.py --timeout 120 --build-timeout 1200

    - name: Run alloctests (release)
      id: alloctests_release
      continue-on-error: true
      run: python Alloctests.py --release --timeout 120 --build-timeout 1200

    - name: Upload alloctests reports
      if: always()
      uses: actions/upload-artifact@v4
      with:
        name: alloctests
        path: |
          target/alloctests/reports/
          target/alloctests/logs/
        if-no-files-found: error

    - name: Require 100% alloctests pass rate
      if: >-
        always() &&
        (
          steps.alloctests_debug.outcome != 'success' ||
          steps.alloctests_release.outcome != 'success'
        )
      run: python -c "raise SystemExit('debug and release alloctests must both pass completely')"