pytest.yml

# Workflow name
name: PyTest and Black

# Controls when the workflow will run
on:
  # Triggers the workflow on pull request (on main only) events
  pull_request:
    branches:
      - main

  # Allows you to run this workflow manually from the Actions tab
  workflow_dispatch:

# A workflow run is made up of one or more jobs that can run sequentially or in parallel
jobs:
  # This workflow contains a single job called "test"
  test:
    # The type of runner that the job will run on and timeout in minutes
    name: Run Python Tests and Black formatter
    runs-on: ubuntu-latest
    timeout-minutes: 10

    # Steps represent a sequence of tasks that will be executed as part of the job
    steps:
      # Checks-out our repository under $GITHUB_WORKSPACE, so our job can access it
      - name: Check out repository code
        uses: actions/checkout@v3

      # Set up Python version
      - name: Set up Python 3.7
        uses: actions/setup-python@v4
        with:
          python-version: '3.7'

      # Runs a set of commands installing Python dependencies using the runners shell (Run a multi-line script)
      - name: Install Python dependencies
        run: |
          python3 -m pip install --upgrade pip
          pip3 install -r requirements-dev.txt

      # Run unit tests
      - name: Test with pytest
        run: |
          export META_CLASSIFIER_PATH=$PWD/docs/metadata_classifiers/
          pytest --exitfirst --verbose --failed-first

      # Check code has been formatted
      - name: Run Black code formatter
        run: |
          black . --check --verbose --diff --color