check-pr.yml

# This workflow runs upon new commits and PRs
# 1. chapter quality check for known issues
# 2. code quality checks, configured in .pre-commit-config.yaml and setup.cfg

name: Check new commits and PRs

on:
  workflow_dispatch:
  push:
    branches: ["main"]
  pull_request:
    branches: ["main"]

permissions:
  contents: read

jobs:
  check:
    runs-on: ubuntu-22.04

    steps:
      - name: Checkout repository
        uses: actions/checkout@v3

      - name: Python set up
        uses: actions/setup-python@v4
        with:
          python-version: "3.10"

      - name: Python cache set up
        uses: actions/cache@v3
        with:
          path: ${{ env.pythonLocation }}
          key: ${{ env.pythonLocation }}-py-cache

      - name: Check chapters for known issues
        run: python3 -O scripts/check_chapters.py

      - name: Check pre-commit tests
        uses: pre-commit/action@v3.0.0