docs: enhance README with detailed descriptions of features and usage… #17
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: Python Tox & Coverage | |
| on: | |
| - push | |
| - pull_request | |
| jobs: | |
| build: | |
| runs-on: ubuntu-latest | |
| strategy: | |
| matrix: | |
| python-version: ['3.11'] | |
| steps: | |
| - uses: actions/checkout@v6 | |
| - name: Set up Python ${{ matrix.python-version }} | |
| uses: actions/setup-python@v6 | |
| with: | |
| python-version: ${{ matrix.python-version }} | |
| - name: Add path to PYTHONPATH | |
| run: | | |
| echo "PYTHONPATH=$GITHUB_WORKSPACE" >> $GITHUB_ENV | |
| - name: Install dependencies | |
| run: | | |
| python -m pip install --upgrade pip | |
| pip install poetry | |
| poetry install | |
| - name: Test with tox | |
| run: poetry run tox | |
| # copy coverage.xml from tox to path: '~/coverage.xml' | |
| - name: Upload coverage.xml | |
| if: ${{ matrix.python-version == '3.11' }} | |
| uses: actions/upload-artifact@v7 | |
| with: | |
| name: upload tox-gh-actions-coverage | |
| path: ${{ github.workspace }}/coverage.xml | |
| if-no-files-found: warn | |
| # upload coverage.xml to codecov | |
| - name: Upload coverage.xml to codecov | |
| if: ${{ matrix.python-version == '3.11' }} | |
| uses: codecov/codecov-action@v6 | |
| with: | |
| token: ${{ secrets.CODECOV_TOKEN }} |