CI.yml

name: CI
on:
  push:
    branches:
      - master
      - release-*
      # You can suffix the branch name with '-runci' to run the CI on that branch
      # without having to open a pull request. This is useful for long-lived branches.
      - '*/*-runci'
    tags: '*'
  pull_request:
  workflow_dispatch:

concurrency:
  # group by workflow and ref; the last slightly strange component ensures that for pull
  # requests, we limit to 1 concurrent job, but for the master branch we don't
  group: ${{ github.workflow }}-${{ github.ref }}-${{ github.ref != 'refs/heads/master' || github.run_number }}
  # Cancel intermediate builds, but only if it is a pull request build.
  cancel-in-progress: ${{ startsWith(github.ref, 'refs/pull/') }}

jobs:
  test:
    name: Julia ${{ matrix.version }} - ${{ matrix.os }} - ${{ matrix.arch }}
    runs-on: ${{ matrix.os }}
    strategy:
      fail-fast: false
      matrix:
        version:
          - 'lts'
          - '1.6'
          - '1'
          - 'nightly'
        os:
          - ubuntu-latest
          - macos-latest
          - windows-latest
        arch:
          - default
        include:
          - os: ubuntu-latest
            version: '1'
            arch: x86
        exclude:
          - os: macos-latest
            version: '1.6'
            arch: default
    steps:
      - uses: actions/checkout@v6
      - uses: julia-actions/setup-julia@v2
        with:
          version: ${{ matrix.version }}
          arch: ${{ matrix.arch }}
          show-versioninfo: true
      - uses: julia-actions/cache@v2
      - uses: julia-actions/julia-buildpkg@v1
      - uses: julia-actions/julia-runtest@v1
        env:
          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
      - uses: julia-actions/julia-processcoverage@v1
      - uses: codecov/codecov-action@v5
        with:
          token: ${{ secrets.CODECOV_TOKEN }}
      - name: Submit coverage to Coveralls
        continue-on-error: true # TODO: https://github.com/JuliaDocs/Documenter.jl/issues/2343
        uses: coverallsapp/github-action@v2
        with:
          github-token: ${{ secrets.GITHUB_TOKEN }}
          path-to-lcov: lcov.info
          flag-name: test-${{ join(matrix.*, '-') }}
          parallel: true

  latex:
    name: "PDF/LaTeX backend - ${{ matrix.os }}"
    runs-on: ${{ matrix.os }}
    strategy:
      fail-fast: false
      matrix:
        os:
          - ubuntu-latest
          - windows-latest
    steps:
      - uses: actions/checkout@v6
      - name: "Download and install DejaVu fonts"
        run: |
          Invoke-WebRequest "https://github.com/dejavu-fonts/dejavu-fonts/releases/download/version_2_37/dejavu-fonts-ttf-2.37.zip" -OutFile "DejaVu.zip"
          Expand-Archive -Path "DejaVu.zip" -DestinationPath "."
          $fonts = (New-Object -ComObject Shell.Application).Namespace(0x14)
          foreach ($file in gci -Path ".\dejavu-fonts-ttf-2.37\ttf" "*.ttf")
          {
            $fonts.CopyHere($file.fullname)
          }
        if: matrix.os == 'windows-latest'
      - uses: actions/setup-python@v6
        with:
          python-version: "3.13"
        if: matrix.os == 'windows-latest'
      - name: "install pygments for tectonic"
        run: pip install pygments
        if: matrix.os == 'windows-latest'
      - uses: TeX-Live/setup-texlive-action@v3
        with:
          packages: |
            scheme-medium
            hyperref
            minted
            newunicodechar
            transparent
            upquote
            tabulary
            tcolorbox
      - uses: julia-actions/setup-julia@v2
        with:
          version: '1'
      - uses: julia-actions/cache@v2
      - name: Instantiate Pkg environment
        shell: julia --color=yes --project=test/examples {0}
        run: |
          using Pkg
          Pkg.instantiate()
      - name: Run test/examples/tests_latex.jl
        run: julia --color=yes --project=test/examples --code-coverage test/examples/tests_latex.jl
      - uses: julia-actions/julia-processcoverage@v1
      - uses: codecov/codecov-action@v5
        with:
          files: lcov.info
          token: ${{ secrets.CODECOV_TOKEN }}
          plugins: noop
          disable_search: true
      - name: Submit coverage to Coveralls
        continue-on-error: true # TODO: https://github.com/JuliaDocs/Documenter.jl/issues/2343
        uses: coverallsapp/github-action@v2
        with:
          github-token: ${{ secrets.GITHUB_TOKEN }}
          path-to-lcov: lcov.info
          flag-name: latex-${{ join(matrix.*, '-') }}
          parallel: true
      - uses: actions/upload-artifact@v6
        with:
          name: "PDFs-${{ matrix.os }}"
          path: test/examples/builds/*/*.pdf

  themes:
    name: "CSS for HTML themes"
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v6
      - uses: julia-actions/setup-julia@v2
        with:
          version: '1'
      - uses: julia-actions/cache@v2
      - name: Install dependencies
        run: make -C assets/html Manifest.toml
      - name: Verify theme CSS files
        run: julia --color=yes --project=assets/html assets/html/verify.jl

  prerender:
    name: "NodeJS for prerender - ${{ matrix.os }}"
    runs-on: ${{ matrix.os }}
    strategy:
      fail-fast: false
      matrix:
        os:
          - windows-latest
          - ubuntu-latest
    steps:
      - uses: actions/checkout@v6
      - uses: julia-actions/setup-julia@v2
        with:
          version: '1'
      - uses: julia-actions/cache@v2
      - run: |
          julia --project=test/prerender/ -e '
            using Pkg
            Pkg.instantiate()
            Pkg.develop(PackageSpec(path=pwd()))'
      - run: julia --color=yes --project=test/prerender --code-coverage test/prerender/prerender.jl
      - uses: julia-actions/julia-processcoverage@v1
      - uses: codecov/codecov-action@v5
        with:
          files: lcov.info
          token: ${{ secrets.CODECOV_TOKEN }}
          plugins: noop
          disable_search: true
      - name: Submit coverage to Coveralls
        continue-on-error: true # TODO: https://github.com/JuliaDocs/Documenter.jl/issues/2343
        uses: coverallsapp/github-action@v2
        with:
          github-token: ${{ secrets.GITHUB_TOKEN }}
          path-to-lcov: lcov.info
          flag-name: prerender-${{ join(matrix.*, '-') }}
          parallel: true

  docs:
    name: 'Documentation: ${{ matrix.format }}'
    runs-on: ubuntu-latest
    strategy:
      fail-fast: false
      matrix:
        format:
          - html
          - pdf
    steps:
      - uses: actions/checkout@v6
      - uses: julia-actions/setup-julia@v2
        with:
          version: '1'
      - uses: julia-actions/cache@v2
      - name: Install dependencies
        run: make docs/Manifest.toml
      - name: Build the manual
        run: julia --color=yes --project=docs/ docs/make.jl ${{ matrix.format }}
        env:
          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
          DOCUMENTER_KEY: ${{ secrets.DOCUMENTER_KEY }}
          DOCUMENTER_LATEX_DEBUG: ${{ github.workspace }}/latex-debug-logs
      - uses: actions/upload-artifact@v6
        if: ${{ always() && matrix.format == 'pdf' }}
        with:
          name: PDF build logs
          path: ${{ github.workspace }}/latex-debug-logs
      - name: Upload search index
        if: ${{ matrix.format == 'html' }}
        uses: actions/upload-artifact@v6
        with:
          name: search-index
          path: docs/build/search_index.js

  benchmarks:
    name: Search Benchmarks
    runs-on: ubuntu-latest
    needs: docs
    steps:
      - uses: actions/checkout@v6
      - uses: julia-actions/setup-julia@v2
        with:
          version: 1
          show-versioninfo: true
      - uses: julia-actions/cache@v2
      - uses: julia-actions/julia-buildpkg@v1
      - name: Instantiate main project environment
        run: julia --project=. -e 'using Pkg; Pkg.instantiate()'
      - name: Download search index
        uses: actions/download-artifact@v7
        with:
          name: search-index
          path: docs/build
      - name: Build search edge cases documentation
        run: |
          cd test/search_edge_cases
          julia --project=. -e 'using Pkg; Pkg.instantiate(); Pkg.develop(PackageSpec(path="../../"))'
          julia --project=. make.jl
      - name: Run search benchmarks
        run: make search-benchmarks
        env:
          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
      - name: Upload search benchmark results
        uses: actions/upload-artifact@v6
        with:
          name: search-benchmark-results
          path: test/search/search_benchmark_results_*.txt

  linkcheck:
    name: "Linkcheck: online tests"
    runs-on: ubuntu-latest
    permissions:
      contents: read
    steps:
      - uses: actions/checkout@v6
      - uses: julia-actions/setup-julia@latest
        with:
          version: '1'
      - name: Install dependencies
        run: julia --color=yes --project=test/online -e'using Pkg; Pkg.instantiate()'
      - name: Run online linkcheck tests
        run: julia --color=yes --project=test/online --code-coverage test/online/runtests.jl
        env:
          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
      - uses: julia-actions/julia-processcoverage@v1
      - uses: codecov/codecov-action@v5
        with:
          files: lcov.info
          token: ${{ secrets.CODECOV_TOKEN }}
          plugins: noop
          disable_search: true
      - name: Submit coverage to Coveralls
        continue-on-error: true # TODO: https://github.com/JuliaDocs/Documenter.jl/issues/2343
        uses: coverallsapp/github-action@v2
        with:
          github-token: ${{ secrets.GITHUB_TOKEN }}
          path-to-lcov: lcov.info
          flag-name: linkcheck-${{ join(matrix.*, '-') }}
          parallel: true

  linkcheck-manual:
    name: "Linkcheck: Documenter manual"
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v6
      - uses: julia-actions/setup-julia@latest
        with:
          version: '1'
      - name: Install dependencies
        run: make docs/Manifest.toml
      - name: Build and check documentation
        run: julia --color=yes --project=docs/ docs/make.jl linkcheck
        env:
          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

  prettier:
    name: Prettier (JS code formatting)
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v6
      - uses: actionsx/prettier@v3
        with:
          args: --check .

  runic:
    name: "Runic (Julia code formatting)"
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v6
      - uses: julia-actions/setup-julia@v2
        with:
          version: '1.11'
      - uses: julia-actions/cache@v2
      - uses: fredrikekre/runic-action@v1
        with:
          version: '1.2'

  typos:
    name: Spell Check with Typos
    runs-on: ubuntu-latest
    steps:
      - name: Checkout Actions Repository
        uses: actions/checkout@v6
      - name: Check spelling
        uses: crate-ci/typos@master

  close-coveralls:
    name: "Close Coveralls Submission"
    needs: [test, latex, prerender, linkcheck]
    if: ${{ always() }}
    runs-on: ubuntu-latest
    steps:
    - name: Coveralls Finished
      uses: coverallsapp/github-action@v2
      with:
        parallel-finished: true