📝 Add dependency to the doc #38
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 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: [ master ] | |
| pull_request: | |
| branches: [ master ] | |
| jobs: | |
| build: | |
| runs-on: ubuntu-latest | |
| strategy: | |
| fail-fast: false | |
| matrix: | |
| python-version: ["3.8", "3.9", "3.10"] | |
| 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 | |
| python -m pip install pytest | |
| if [ -f requirements.txt ]; then pip install -r requirements.txt; fi | |
| - name: Lint with pylint | |
| run: | | |
| pylint pyformlang || true | |
| - name: Lint with pycodestyle | |
| run: | | |
| pycodestyle pyformlang || true | |
| - name: Test with pytest | |
| run: | | |
| pytest --showlocals -v pyformlang | |
| - name: Build coverage file | |
| if: ${{ matrix.python-version == '3.8'}} | |
| run: | | |
| pytest pyformlang --junitxml=pytest.xml --cov=pyformlang | tee ./pytest-coverage.txt | |
| - name: Pytest coverage comment | |
| if: ${{ matrix.python-version == '3.8'}} | |
| uses: MishaKav/pytest-coverage-comment@main | |
| id: coverageComment | |
| with: | |
| pytest-coverage-path: ./pytest-coverage.txt | |
| junitxml-path: ./pytest.xml | |
| default-branch: master | |
| - name: Create coverage Badge | |
| if: ${{ matrix.python-version == '3.8'}} | |
| uses: schneegans/dynamic-badges-action@v1.0.0 | |
| with: | |
| auth: ${{ secrets.GIST_SECRET }} | |
| gistID: 135f01c630063c3e69d999a2edf59fdb | |
| filename: coverage_pyformlang.json | |
| label: Coverage Report | |
| message: ${{ steps.coverageComment.outputs.coverage }} | |
| color: ${{ steps.coverageComment.outputs.color }} | |
| namedLogo: python |