Simplify own PyPI README #131
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] | |
| tags: ["*"] | |
| pull_request: | |
| branches: [main] | |
| workflow_dispatch: | |
| env: | |
| FORCE_COLOR: "1" # Make tools pretty. | |
| PYTHONIOENCODING: utf-8 | |
| TOX_TESTENV_PASSENV: FORCE_COLOR | |
| PIP_DISABLE_PIP_VERSION_CHECK: "1" | |
| PIP_NO_PYTHON_VERSION_WARNING: "1" | |
| SETUPTOOLS_SCM_PRETEND_VERSION: "1.0" # avoid warnings about shallow checkout | |
| PYTHON_LATEST: "3.11" | |
| jobs: | |
| tests: | |
| name: Tests on ${{ matrix.python-version }} | |
| runs-on: ubuntu-latest | |
| strategy: | |
| fail-fast: false | |
| matrix: | |
| python-version: ["3.7", "3.8", "3.9", "3.10", "3.11"] | |
| steps: | |
| - uses: actions/checkout@v3 | |
| - uses: actions/setup-python@v4 | |
| with: | |
| python-version: ${{ matrix.python-version }} | |
| - run: python -Im pip install --upgrade wheel tox | |
| - run: python -Im tox run -f py$(echo ${{ matrix.python-version }} | tr -d .) | |
| - name: Upload coverage data | |
| uses: actions/upload-artifact@v3 | |
| with: | |
| name: coverage-data | |
| path: .coverage.* | |
| if-no-files-found: ignore | |
| coverage: | |
| runs-on: ubuntu-latest | |
| needs: tests | |
| steps: | |
| - uses: actions/checkout@v3 | |
| - uses: actions/setup-python@v4 | |
| with: | |
| python-version: ${{ env.PYTHON_LATEST }} | |
| - run: python -Im pip install --upgrade coverage[toml] | |
| - name: Download coverage data | |
| uses: actions/download-artifact@v3 | |
| with: | |
| name: coverage-data | |
| - name: Combine coverage and fail if it's <100%. | |
| run: | | |
| python -Im coverage combine | |
| python -Im coverage html --skip-covered --skip-empty | |
| python -Im coverage report --fail-under=100 | |
| - name: Upload HTML report if check failed. | |
| uses: actions/upload-artifact@v3 | |
| with: | |
| name: html-report | |
| path: htmlcov | |
| if: ${{ failure() }} | |
| mypy: | |
| name: Mypy | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@v3 | |
| - uses: actions/setup-python@v4 | |
| with: | |
| python-version: ${{ env.PYTHON_LATEST }} | |
| - run: python -Im pip install --upgrade wheel tox | |
| - run: python -Im tox run -e mypy | |
| install-dev: | |
| name: Verify dev env | |
| runs-on: ${{ matrix.os }} | |
| strategy: | |
| matrix: | |
| os: [ubuntu-latest, windows-latest] | |
| steps: | |
| - uses: actions/checkout@v3 | |
| - uses: actions/setup-python@v4 | |
| with: | |
| python-version: ${{ env.PYTHON_LATEST }} | |
| - run: python -Im pip install -e .[dev] | |
| - run: python -Ic 'import hatch_fancy_pypi_readme' | |
| - run: python -m hatch_fancy_pypi_readme tests/example_pyproject.toml | |
| - run: hatch-fancy-pypi-readme tests/example_pyproject.toml | |
| # Ensure everything required is passing for branch protection. | |
| required-checks-pass: | |
| if: always() | |
| needs: | |
| - coverage | |
| - install-dev | |
| runs-on: ubuntu-latest | |
| steps: | |
| - name: Decide whether the needed jobs succeeded or failed | |
| uses: re-actors/alls-green@release/v1 | |
| with: | |
| jobs: ${{ toJSON(needs) }} |