spellcheck.yml

name: spell_check

on:
  workflow_dispatch:
  pull_request:
    branches:
    - 'main'
    - 'develop'
    paths:
      - '.ci/spellcheck/*'
      - 'README.md'
      - 'CONTRIBUTING.md'
      - 'notebooks/**.md'
      - 'notebooks/**.ipynb'
  push:
    branches:
    - 'main'
    paths:
      - '.ci/spellcheck/*'
      - 'README.md'
      - 'CONTRIBUTING.md'
      - 'notebooks/**.md'
      - 'notebooks/**.ipynb'

jobs:
  build_spellcheck:
    strategy:
      fail-fast: false
    runs-on: ubuntu-20.04  # change cachepip step when changing this
    steps:
    - name: Checkout repository
      uses: actions/checkout@v4

    - name: Dotenv Action
      id: dotenv
      uses: xom9ikk/dotenv@v1.0.2
      with:
        path: ./.github/workflows

    - name: Set up Python
      uses: actions/setup-python@v5
      with:
        python-version: 3.8  # change cachepip step when changing this

    - name: Cache OpenVINO Pip Packages
      id: cachepip
      uses: actions/cache@v3
      with:
        path: |
          pipcache
        key: ${{ env.PIP_CACHE_KEY }}-ubuntu-20.04-3.8

    - name: Install dependencies
      run: |
        python -m pip install --upgrade pip
        python -m pip install -r .ci/dev-requirements.txt --cache-dir pipcache
        python -m ipykernel install --user --name openvino_env

    - name: Install Aspell
      run: |
        sudo apt-get install aspell aspell-en

    - name: Run spell check
      run: |
        python .ci/spellcheck/run_spellcheck.py