ci.yml

name: CI

on:
  push:
    branches: [main]
  pull_request:
    types: [labeled, opened, synchronize, reopened]
  workflow_dispatch:
    inputs:
      debug_enabled:
        type: boolean
        description: 'Run with tmate debugging enabled for testing'
        required: false
        default: false
  merge_group:
    types: [checks_requested]

concurrency:
  group: ${{ github.workflow }}-${{ github.head_ref || github.run_id }}
  cancel-in-progress: true

permissions:
  contents: read # to fetch code (actions/checkout)

jobs:
  get_dataset:
    env:
      cache-name: dataset

    name: Get / Update Example Dataset
    runs-on: ubuntu-latest
    steps:
      - name: Checkout ${{github.repository }}
        uses: actions/checkout@v4
        with:
          fetch-depth: 0

      - name: Restore Example Dataset Cache
        uses: actions/cache@v4
        id: dataset-cache
        with:
          path: ./data/cache/
          key: huggingface-${{ env.cache-name }}
          enableCrossOsArchive: true

      - name: Set up Python
        uses: actions/setup-python@v5
        with:
          python-version: "3.11"
          cache-dependency-path: "**/pyproject.toml"
          cache: "pip"
      - name: Check the Example Dataset Cache
        run: |
          pip install datasets
          python ./.github/scripts/get_example_dataset.py

  test:
    needs: [get_dataset]
    name: Test
    permissions:
      contents: read
      pull-requests: write
    secrets: inherit
    uses: ./.github/workflows/test.yml
    with:
      debug_enabled: ${{ inputs.debug_enabled }}
  
  build:
    name: Build
    permissions:
      contents: read
      pull-requests: write
    secrets: inherit
    uses: ./.github/workflows/build.yml

  upload_coverage:
    needs: [test]
    name: Upload Coverage
    runs-on: ubuntu-latest
    steps:
      - name: Checkout ${{github.repository }}
        uses: actions/checkout@v4
        with:
          fetch-depth: 0

      - name: Download Coverage Artifact
        uses: actions/download-artifact@v4
        with:
          pattern: coverage-*
          merge-multiple: true
          path: .

      - name: Upload Coverage to Coveralls
        uses: coverallsapp/github-action@v2
        with:
          github-token: ${{ secrets.GITHUB_TOKEN }}