python-package.yml

# This workflow will install Python dependencies, run tests and lint with a variety of Python versions
# For more information see: https://docs.github.com/en/actions/automating-builds-and-tests/building-and-testing-python

name: build

env:
  package: codext

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

jobs:
  build:
    runs-on: ${{ matrix.os }}
    strategy:
      fail-fast: false
      matrix:
        os: [ubuntu-latest]
        python-version: ["3.8", "3.9", "3.10", "3.11", "3.12"]
    steps:
    - uses: actions/checkout@v3
    - name: Set up Python ${{ matrix.python-version }}
      uses: actions/setup-python@v4
      with:
        python-version: ${{ matrix.python-version }}
    - name: Install ${{ env.package }}
      run: |
        python -m pip install --upgrade pip
        python -m pip install flake8 pytest pytest-cov pytest-pythonpath coverage
        pip install -r requirements.txt
        pip install .
    - 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: Test ${{ env.package }} with pytest
      run: |
        pytest --cov=$package
  coverage:
    needs: build
    runs-on: ubuntu-latest
    env:
      cov_badge_path: docs/coverage.svg
    steps:
    - uses: actions/checkout@v3
    - name: Install ${{ env.package }}
      run: |
        python -m pip install --upgrade pip
        python -m pip install pytest pytest-cov pytest-pythonpath
        pip install -r requirements.txt
        pip install .
    - name: Make coverage badge for ${{ env.package }}
      run: |
        pip install genbadge[coverage]
        pytest --cov=$package --cov-report=xml
        genbadge coverage -i coverage.xml -o $cov_badge_path
    - name: Verify Changed files
      uses: tj-actions/verify-changed-files@v17
      id: changed_files
      with:
        files: ${{ env.cov_badge_path }}
    - name: Commit files
      if: steps.changed_files.outputs.files_changed == 'true'
      run: |
        git config --local user.email "github-actions[bot]@users.noreply.github.com"
        git config --local user.name "github-actions[bot]"
        git add $cov_badge_path
        git commit -m "Updated coverage.svg"
    - name: Push changes
      if: steps.changed_files.outputs.files_changed == 'true'
      uses: ad-m/github-push-action@master
      with:
        github_token: ${{ secrets.github_token }}
        branch: ${{ github.ref }}