[README] Update readme for testing read() in aiofiles' stream #155
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
| --- | |
| name: CI | |
| on: | |
| push: | |
| branches: ["main"] | |
| pull_request: | |
| branches: ["main"] | |
| workflow_dispatch: | |
| jobs: | |
| tests: | |
| name: "Python ${{ matrix.python-version }}" | |
| runs-on: ${{ matrix.os }} | |
| strategy: | |
| matrix: | |
| os: [ubuntu-latest, windows-latest] | |
| python-version: | |
| ["3.7", "3.8", "3.9", "3.10", "3.11", "3.12", "pypy-3.9"] | |
| steps: | |
| - uses: "actions/checkout@v3" | |
| - uses: "actions/setup-python@v4" | |
| with: | |
| python-version: "${{ matrix.python-version }}" | |
| allow-prereleases: true | |
| - name: "Install dependencies" | |
| run: | | |
| python -VV | |
| python -m site | |
| python -m pip install --upgrade pip wheel pdm | |
| python -m pip install --upgrade tox tox-gh-actions | |
| - name: "Run tox targets for ${{ matrix.python-version }}" | |
| run: "python -m tox" | |
| - name: "Upload coverage data" | |
| uses: "actions/upload-artifact@v3" | |
| with: | |
| name: "coverage-data" | |
| path: ".coverage.*" | |
| if-no-files-found: "ignore" | |
| if: runner.os == 'Linux' | |
| coverage: | |
| name: "Combine & check coverage." | |
| needs: "tests" | |
| runs-on: "ubuntu-latest" | |
| steps: | |
| - uses: "actions/checkout@v3" | |
| - uses: "actions/setup-python@v4" | |
| with: | |
| cache: "pip" | |
| python-version: "3.11" | |
| - run: "python -Im pip install --upgrade coverage[toml]" | |
| - uses: "actions/download-artifact@v3" | |
| with: | |
| name: "coverage-data" | |
| - name: "Combine coverage" | |
| run: | | |
| python -Im coverage combine | |
| python -Im coverage html --skip-covered --skip-empty | |
| python -Im coverage json | |
| # Report and write to summary. | |
| python -Im coverage report | sed 's/^/ /' >> $GITHUB_STEP_SUMMARY | |
| export TOTAL=$(python -c "import json;print(json.load(open('coverage.json'))['totals']['percent_covered_display'])") | |
| echo "total=$TOTAL" >> $GITHUB_ENV | |
| - name: "Upload HTML report." | |
| uses: "actions/upload-artifact@v3" | |
| with: | |
| name: "html-report" | |
| path: "htmlcov" | |
| - name: "Make badge" | |
| if: github.ref == 'refs/heads/main' | |
| uses: "schneegans/[email protected]" | |
| with: | |
| # GIST_TOKEN is a GitHub personal access token with scope "gist". | |
| auth: ${{ secrets.GIST_TOKEN }} | |
| gistID: 882f02e3df32136c847ba90d2688f06e | |
| filename: covbadge.json | |
| label: Coverage | |
| message: ${{ env.total }}% | |
| minColorRange: 50 | |
| maxColorRange: 90 | |
| valColorRange: ${{ env.total }} | |
| package: | |
| name: "Build & verify package" | |
| runs-on: "ubuntu-latest" | |
| steps: | |
| - uses: "actions/checkout@v3" | |
| - uses: "actions/setup-python@v4" | |
| with: | |
| python-version: "3.x" | |
| - name: "Install PDM and twine" | |
| run: "python -m pip install pdm twine check-wheel-contents" | |
| - name: "Build package" | |
| run: "pdm build" | |
| - name: "List result" | |
| run: "ls -l dist" | |
| - name: "Check wheel contents" | |
| run: "check-wheel-contents dist/*.whl" | |
| - name: "Check long_description" | |
| run: "python -m twine check dist/*" |