user-guide-python-examples.yml

name: Test Python User Guide Examples

on:
  push:
    branches: [ "main" ]
  pull_request:
    branches: [ "main" ]
  schedule:
    - cron: '15 08 * * *' # Run in the early hours of the morning (UTC)
  workflow_dispatch:

permissions:
  contents: read

jobs:
  test:

    runs-on: ubuntu-latest

    defaults:
      run:
        working-directory: user_guide_examples
        
    steps:
    - uses: actions/checkout@v3
    - name: Set up Python 3.10
      uses: actions/setup-python@v4
      with:
        python-version: "3.10"
    - name: Install dependencies
      run: |
        python -m pip install --upgrade pip
        pip install flake8 pytest
        if [ -f requirements.txt ]; then pip install -r requirements.txt; fi
#    - name: Lint with flake8
#      run: |
#        # stop the build if there are Python syntax errors or undefined names
#        flake8 . --count --select=E9,F63,F7,F82 --show-source --statistics
#        # exit-zero treats all errors as warnings. The GitHub editor is 127 chars wide
#        flake8 . --count --exit-zero --max-complexity=10 --max-line-length=127 --statistics
    - name: Install latest HELICS PyPI release with CLI
      run: pip install helics[cli]
    - name: Run user guide examples
      timeout-minutes: 2
      run: |
        ./run_fundamental_user_guide_examples.sh
        ./run_advanced_user_guide_examples.sh
       
#    - name: Test with pytest
#      run: |
#        pytest