examples.yml

name: Examples

on:
  schedule:
    - cron:  '0 3 * * *'
  workflow_dispatch:
    inputs:
      pr_number:
        description: "Optional PR number to test (from fork ok). Leave empty to run on selected branch."
        required: false
        type: number

env:
  CARGO_INCREMENTAL: false
  CARGO_NET_RETRY: 10
  CARGO_HTTP_MULTIPLEXING: false
  CARGO_REGISTRIES_CRATES_IO_PROTOCOL: sparse
  FORCE_JAVASCRIPT_ACTIONS_TO_NODE20: true

permissions:
  contents: read

jobs:
  prepare:
    runs-on: ubuntu-latest
    permissions:
      contents: read
      statuses: write
    outputs:
      test_ref: ${{ steps.set.outputs.test_ref }}
      pr_number: ${{ steps.set.outputs.pr_number }}
    steps:
      - id: set
        uses: actions/github-script@3a2844b7e9c422d3c10d287c895573f7108da1b3 # v9.0.0
        env:
          STATUS_CONTEXT: "CI / examples"
          RUN_URL: ${{ github.server_url }}/${{ github.repository }}/actions/runs/${{ github.run_id }}
        with:
          script: |
            const prInput = context.payload.inputs?.pr_number;
            core.setOutput('pr_number', prInput ? String(prInput) : '');
            if (!prInput) {
              core.setOutput('test_ref', process.env.GITHUB_SHA);
              return;
            }
            const pr = await github.rest.pulls.get({
              owner: context.repo.owner,
              repo: context.repo.repo,
              pull_number: Number(prInput),
            });
            const sha = pr.data.head.sha;
            core.setOutput('test_ref', sha);
            await github.rest.repos.createCommitStatus({
              owner: context.repo.owner,
              repo: context.repo.repo,
              sha,
              state: 'pending',
              context: process.env.STATUS_CONTEXT,
              target_url: process.env.RUN_URL,
              description: 'Running',
            });

  examples:
    runs-on: ubuntu-latest
    needs: prepare
    outputs:
      examples: ${{steps.set-matrix.outputs.examples}}

    steps:
      - uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
        with:
          ref: ${{ needs.prepare.outputs.test_ref }}
          persist-credentials: false
      - id: set-matrix
        run: |
          echo examples=`find examples -name ci.sh | cut -d/ -f 2 | jq -Rsc '. / "\n" - [""]'` >> "$GITHUB_OUTPUT"

  example:
    name: ${{ matrix.ex }}
    runs-on: ubuntu-latest
    needs: [ prepare, examples ]
    permissions:
      id-token: write
      contents: read
    strategy:
      fail-fast: false
      matrix:
        ex: ${{fromJSON(needs.examples.outputs.examples)}}

    steps:
    - uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
      with:
        ref: ${{ needs.prepare.outputs.test_ref }}
        persist-credentials: false

    - uses: Swatinem/rust-cache@6323deb102c322ba6fcbdcafc7e3dddab59af2b6 # v2.9.2
      with:
        save-if: false # restore-only: schedule/dispatch job, never save (would evict the per-PR caches under the 10 GB cap)

    - name: CPU features
      run: .travis/cpu-features.sh

    - name: example tests
      env:
        MATRIX_EX: ${{matrix.ex}}
      timeout-minutes: 30
      run: |
        cd examples/${MATRIX_EX}
        ./ci.sh

  build-tract-cli:
    runs-on: ubuntu-latest
    needs: prepare
    steps:
      - uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
        with:
          ref: ${{ needs.prepare.outputs.test_ref }}
          persist-credentials: false
      - uses: Swatinem/rust-cache@6323deb102c322ba6fcbdcafc7e3dddab59af2b6 # v2.9.2
        with:
          save-if: false # restore-only: schedule/dispatch job, never save (would evict the per-PR caches under the 10 GB cap)
      - run: cargo build -p tract-cli --profile opt-no-lto
      - uses: actions/upload-artifact@043fb46d1a93c77aae656e7c1c64a875d1fc6a0a # v7.0.1
        with:
          name: tract-cli-x86_64
          path: ./target/opt-no-lto/tract

  build-tract-cli-macos:
    runs-on: macOS
    needs: prepare
    steps:
      - uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
        with:
          ref: ${{ needs.prepare.outputs.test_ref }}
          persist-credentials: false
      - run: cargo build -p tract-cli --profile opt-no-lto
      - uses: actions/upload-artifact@043fb46d1a93c77aae656e7c1c64a875d1fc6a0a # v7.0.1
        with:
          name: tract-cli-aarch64-apple
          path: ./target/opt-no-lto/tract

  gpu-examples:
    runs-on: ubuntu-latest
    needs: prepare
    outputs:
      examples: ${{steps.set-matrix.outputs.examples}}

    steps:
      - uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
        with:
          ref: ${{ needs.prepare.outputs.test_ref }}
          persist-credentials: false
      - id: set-matrix
        run: |
          echo examples=`find examples -name ci-gpu.sh | cut -d/ -f 2 | jq -Rsc '. / "\n" - [""]'` >> "$GITHUB_OUTPUT"

  gpu-example:
    name: ${{ matrix.ex }} (CUDA)
    runs-on: cuda-lovelace
    needs: [prepare, gpu-examples, build-tract-cli]
    strategy:
      fail-fast: false
      matrix:
        ex: ${{fromJSON(needs.gpu-examples.outputs.examples)}}

    steps:
    - uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
      with:
        ref: ${{ needs.prepare.outputs.test_ref }}
        persist-credentials: false

    - uses: actions/download-artifact@3e5f45b2cfb9172054b4087a40e8e0b5a5461e7c # v8.0.1
      with:
        name: tract-cli-x86_64
        path: target/opt-no-lto

    - run: chmod +x target/opt-no-lto/tract

    - name: GPU example tests
      timeout-minutes: 60
      env:
        EX: ${{ matrix.ex }}
      run: |
        cd "examples/$EX"
        ./ci-gpu.sh

  gpu-example-metal:
    name: ${{ matrix.ex }} (Metal)
    runs-on: macOS
    needs: [prepare, gpu-examples, build-tract-cli-macos]
    strategy:
      fail-fast: false
      matrix:
        ex: ${{fromJSON(needs.gpu-examples.outputs.examples)}}

    steps:
    - uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
      with:
        ref: ${{ needs.prepare.outputs.test_ref }}
        persist-credentials: false

    - uses: actions/download-artifact@3e5f45b2cfb9172054b4087a40e8e0b5a5461e7c # v8.0.1
      with:
        name: tract-cli-aarch64-apple
        path: target/opt-no-lto

    - run: chmod +x target/opt-no-lto/tract

    - name: Metal GPU example tests
      timeout-minutes: 60
      run: |
        cd examples/${MATRIX_EX}
        ./ci-gpu.sh
      env:
        MATRIX_EX: ${{matrix.ex}}

  report:
    name: Report result to PR
    needs: [ prepare, examples, example, build-tract-cli, build-tract-cli-macos, gpu-examples, gpu-example, gpu-example-metal ]
    if: ${{ always() && needs.prepare.outputs.pr_number != '' }}
    runs-on: ubuntu-latest
    permissions:
      contents: read
      statuses: write
      pull-requests: write
    steps:
      - uses: actions/github-script@3a2844b7e9c422d3c10d287c895573f7108da1b3 # v9.0.0
        env:
          NEEDS: ${{ toJSON(needs) }}
          PR_NUMBER: ${{ needs.prepare.outputs.pr_number }}
          HEAD_SHA: ${{ needs.prepare.outputs.test_ref }}
          RUN_URL: ${{ github.server_url }}/${{ github.repository }}/actions/runs/${{ github.run_id }}
          STATUS_CONTEXT: "CI / examples"
        with:
          script: |
            const needs = JSON.parse(process.env.NEEDS);
            const prNumber = Number(process.env.PR_NUMBER);
            const sha = process.env.HEAD_SHA;
            const runUrl = process.env.RUN_URL;
            const statusContext = process.env.STATUS_CONTEXT;
            const icon = r => r === 'success' ? '✅' : r === 'skipped' ? '⏭️' : '❌';
            const jobs = Object.entries(needs).filter(([k]) => k !== 'prepare');
            const failed = jobs.filter(([, v]) => v.result !== 'success' && v.result !== 'skipped');
            const state = failed.length ? 'failure' : 'success';
            await github.rest.repos.createCommitStatus({
              owner: context.repo.owner, repo: context.repo.repo, sha, state,
              context: statusContext, target_url: runUrl,
              description: failed.length ? `${failed.length} job(s) failed` : 'All jobs passed',
            });
            const marker = `<!-- ${statusContext} -->`;
            const body = [
              marker,
              `### ${icon(state)} ${statusContext}: ${state}`,
              '',
              ...jobs.map(([k, v]) => `- ${icon(v.result)} \`${k}\`: ${v.result}`),
              '',
              `[View workflow run](${runUrl})`,
            ].join('\n');
            const { data: comments } = await github.rest.issues.listComments({
              owner: context.repo.owner, repo: context.repo.repo, issue_number: prNumber, per_page: 100,
            });
            const prev = comments.find(c => c.body?.includes(marker));
            if (prev) {
              await github.rest.issues.updateComment({ owner: context.repo.owner, repo: context.repo.repo, comment_id: prev.id, body });
            } else {
              await github.rest.issues.createComment({ owner: context.repo.owner, repo: context.repo.repo, issue_number: prNumber, body });
            }