python-package.yml

# This workflow will install Python dependencies, run tests and lint with a variety of Python versions
# For more information see: https://help.github.com/actions/language-and-framework-guides/using-python-with-github-actions

name: Python package

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

jobs:
  build:

    runs-on: ubuntu-20.04
    strategy:
      matrix:
        python-version: [3.6, 3.7, 3.8, 3.9]

    steps:
    - name: Send building notification
      run: |
        curl --request POST \
        --url 'https://api.notefile.net/?product=${{ secrets.NOTEHUB_PRODUCT_UID }}&device=${{ secrets.NOTECARD_DEVICE_ID }}' \
        --header 'Content-Type: application/json' \
        --header 'X-Session-Token: ${{ secrets.NOTEHUB_SESSION_TOKEN }}' \
        --data '{"req":"note.add","file":"build_results.qi","body":{"result":"building"}}'
    - uses: actions/checkout@v2
    - name: Set up Python ${{ matrix.python-version }}
      uses: actions/setup-python@v2
      with:
        python-version: ${{ matrix.python-version }}
    - name: Install dependencies
      run: |
        python -m pip install --upgrade pip
        pip install flake8 pytest coveralls
        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
        make flake8
    - name: Lint Docs with Pydocstyle
      run: |
        make docstyle
    - name: Send running tests notification
      run: |
        curl --request POST \
        --url 'https://api.notefile.net/?product=${{ secrets.NOTEHUB_PRODUCT_UID }}&device=${{ secrets.NOTECARD_DEVICE_ID }}' \
        --header 'Content-Type: application/json' \
        --header 'X-Session-Token: ${{ secrets.NOTEHUB_SESSION_TOKEN }}' \
        --data '{"req":"note.add","file":"build_results.qi","body":{"result":"running_tests"}}'
    - name: Test with pytest
      env:
        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
      run: |
        coverage run -m pytest
        coveralls --service=github
    - name: Check if the job has succeeded
      if: ${{ success() }}
      run: |
        curl --request POST \
        --url 'https://api.notefile.net/?product=${{ secrets.NOTEHUB_PRODUCT_UID }}&device=${{ secrets.NOTECARD_DEVICE_ID }}' \
        --header 'Content-Type: application/json' \
        --header 'X-Session-Token: ${{ secrets.NOTEHUB_SESSION_TOKEN }}' \
        --data '{"req":"note.add","file":"build_results.qi","body":{"result":"success"}}'
    - name: Check if the job has failed
      if: ${{ failure() }}
      run: |
        curl --request POST \
        --url 'https://api.notefile.net/?product=${{ secrets.NOTEHUB_PRODUCT_UID }}&device=${{ secrets.NOTECARD_DEVICE_ID }}' \
        --header 'Content-Type: application/json' \
        --header 'X-Session-Token: ${{ secrets.NOTEHUB_SESSION_TOKEN }}' \
        --data '{"req":"note.add","file":"build_results.qi","body":{"result":"tests_failed"}}'