Update documentation #76
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
# This workflow is for feature branches. It sets up python, lints with several analyzers, | |
# runs tests, collects test coverage and makes a coverage comment. | |
name: Build feature | |
on: | |
push: | |
branches-ignore: "master" | |
pull_request: | |
jobs: | |
build: | |
runs-on: ubuntu-latest | |
strategy: | |
fail-fast: false | |
matrix: | |
python-version: ["3.8"] | |
steps: | |
- uses: actions/checkout@v3 | |
- name: Set up Python ${{ matrix.python-version }} | |
uses: actions/setup-python@v3 | |
with: | |
python-version: ${{ matrix.python-version }} | |
- name: Install dependencies | |
run: | | |
python -m pip install --upgrade pip | |
pip install -r requirements.txt | |
- name: Lint with pylint | |
run: | | |
pylint pyformlang || true | |
- name: Lint with pycodestyle | |
run: | | |
pycodestyle pyformlang || true | |
- name: Lint with ruff | |
run: | | |
ruff check pyformlang || true | |
- name: Check with pyright | |
run: | | |
pyright --stats pyformlang | |
- name: Test with pytest | |
run: | | |
pytest --showlocals -v pyformlang | |
- name: Build coverage file | |
run: | | |
pytest pyformlang --junitxml=pytest.xml --cov=pyformlang | tee ./pytest-coverage.txt | |
- name: Make coverage comment | |
uses: MishaKav/pytest-coverage-comment@main | |
id: coverageComment | |
with: | |
pytest-coverage-path: ./pytest-coverage.txt | |
junitxml-path: ./pytest.xml | |
default-branch: master |