docs: add Codacy grade badge to README #41
Workflow file for this run
This file contains hidden or 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
| name: CI | |
| on: | |
| push: | |
| branches: [main] | |
| pull_request: | |
| branches: [main] | |
| jobs: | |
| unittest: | |
| runs-on: ubuntu-latest | |
| strategy: | |
| matrix: | |
| python-version: ["3.9", "3.10", "3.11", "3.12", "3.13", "3.14"] | |
| steps: | |
| - uses: actions/checkout@v7 | |
| - name: Set up Python ${{ matrix.python-version }} | |
| uses: actions/setup-python@v7 | |
| with: | |
| python-version: ${{ matrix.python-version }} | |
| - name: Install dependencies | |
| run: | | |
| python -m pip install --upgrade pip | |
| pip install .[dev] | |
| sudo apt-get update | |
| sudo apt-get install -y graphviz | |
| - name: Test with pytest | |
| run: pytest | |
| mypy: | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@v7 | |
| - name: Set up Python 3.11 | |
| uses: actions/setup-python@v7 | |
| with: | |
| python-version: "3.11" | |
| - name: Install dependencies | |
| run: | | |
| python -m pip install --upgrade pip | |
| pip install .[dev] | |
| - name: Run mypy | |
| # Informational only for now: the type-hinting pass surfaced a | |
| # baseline of pre-existing design tensions (Liskov-incompatible | |
| # overrides, embedded-graph invariants not visible to the type | |
| # checker) that are tracked separately, not fixed here. Don't fail | |
| # the build on them yet. | |
| continue-on-error: true | |
| run: mypy src/pgraph/PGraph.py | |
| all-tests-passed: | |
| name: All tests passed | |
| needs: unittest | |
| runs-on: ubuntu-latest | |
| if: always() | |
| steps: | |
| - name: Check test matrix result | |
| run: | | |
| if [ "${{ needs.unittest.result }}" != "success" ]; then | |
| echo "test matrix did not succeed: ${{ needs.unittest.result }}" | |
| exit 1 | |
| fi | |
| codecov: | |
| needs: unittest | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@v7 | |
| - name: Set up Python 3.11 | |
| uses: actions/setup-python@v7 | |
| with: | |
| python-version: "3.11" | |
| - name: Install dependencies | |
| run: | | |
| python -m pip install --upgrade pip | |
| pip install -e .[dev] | |
| sudo apt-get update | |
| sudo apt-get install -y graphviz | |
| - name: Run coverage | |
| run: | | |
| pytest --cov=pgraph --cov-report=xml:coverage.xml | |
| coverage report | |
| - name: Upload coverage to Codecov | |
| uses: codecov/codecov-action@v7 | |
| with: | |
| files: ./coverage.xml | |
| verbose: true | |
| docs: | |
| if: github.event_name == 'push' | |
| needs: unittest | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@v7 | |
| - name: Set up Python 3.11 | |
| uses: actions/setup-python@v7 | |
| with: | |
| python-version: "3.11" | |
| - name: Install dependencies | |
| run: | | |
| python -m pip install --upgrade pip | |
| pip install .[docs] | |
| sudo apt-get update | |
| sudo apt-get install -y graphviz | |
| - name: Build docs | |
| run: | | |
| make -C docs html | |
| touch docs/build/html/.nojekyll | |
| - name: Deploy docs to gh-pages | |
| uses: peaceiris/actions-gh-pages@v4 | |
| with: | |
| github_token: ${{ secrets.GITHUB_TOKEN }} | |
| publish_branch: gh-pages | |
| publish_dir: ./docs/build/html |