ci.yaml

name: Install and Run Tests

on:
  push:
    branches:
      - "main"
    tags:
      - "*"
  pull_request:
  workflow_dispatch:

concurrency:
  group: ${{ github.workflow }}-${{ github.ref }}
  cancel-in-progress: true

jobs:
  pre-commit:
    name: Linting
    runs-on: ubuntu-latest
    steps:
      - uses: ucl/composite-actions/pre-commit@v1

  install:
    name: Test install
    strategy:
      fail-fast: false
      matrix:
        os: [ubuntu-latest, macos-latest, windows-latest]
    runs-on: ${{ matrix.os }}
    steps:
      - name: Checkout repository
        uses: actions/checkout@v4

      - name: Setup python
        uses: actions/setup-python@v4
        with:
          python-version: "3.10"

      - name: Attempt install
        run: |
          pip install .

      - name: Smoke test CLI help
        run: |
          assignment-checker --help

  test:
    name: Run tests
    needs: install
    strategy:
      fail-fast: false
      matrix:
        os: [ubuntu-latest, macos-latest, windows-latest]
    runs-on: ${{ matrix.os }}
    steps:
      - name: Checkout repository
        uses: actions/checkout@v4

      - name: Setup python
        uses: actions/setup-python@v4
        with:
          python-version: "3.10"

      - name: Setup tox
        run: |
          pip install tox tox-gh-actions

      - name: Prepare git config so tox can inherit
        run: |
          git config --global user.email "arc.teaching@ucl.ac.uk"
          git config --global user.name "ARC Teaching"

      - name: Run tests with tox
        run: tox