docs: update instructions to run py3make #237
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 and run tests with a variety of Python versions | |
| # It uses the Python Package GitHub Actions workflow. | |
| # For more information see: https://docs.github.com/en/actions/automating-builds-and-tests/building-and-testing-python | |
| # and https://www.youtube.com/watch?v=l6fV09z5XHk | |
| name: ci-build | |
| on: | |
| push: | |
| branches: | |
| - master # $default-branch only works in Workflows templates, not in Workflows, see https://stackoverflow.com/questions/64781462/github-actions-default-branch-variable | |
| pull_request: | |
| branches: | |
| - master | |
| jobs: | |
| unittests: | |
| name: Unit tests on a matrix of Python versions and OSes | |
| runs-on: ${{ matrix.os }} | |
| strategy: | |
| fail-fast: false | |
| matrix: | |
| python-version: ["3.7", "3.8", "3.9", "3.10", "*", "3.12-dev", pypy-3.8, pypy-3.9] # check the list of versions: https://github.com/actions/python-versions/releases and https://github.com/actions/setup-python/blob/main/docs/advanced-usage.md -- note that "*" represents the latest stable version of Python | |
| os: [ ubuntu-latest, windows-latest, macos-latest ] # jobs that run on Windows and macOS runners that GitHub hosts consume minutes at 2 and 10 times the rate that jobs on Linux runners consume respectively. But it's free for public OSS repositories. | |
| steps: | |
| - uses: actions/checkout@v3 | |
| - name: Set up Python ${{ matrix.python-version }} | |
| uses: actions/setup-python@v3 | |
| with: | |
| python-version: ${{ matrix.python-version }} | |
| cache: 'pip' | |
| # You can test your matrix by printing the current Python version | |
| - name: Display Python version | |
| run: | | |
| python -c "import sys; print(sys.version)" | |
| - name: Install dependencies | |
| run: | | |
| python -m pip install --upgrade pip | |
| # The rest is managed by the pyproject.toml | |
| - name: Compile the Cython extension (only on latest stable Python version) | |
| if: ${{ matrix.python-version == '*' }} # need to use single quotes for literal strings, otherwise with double quotes GitHub expression will fail: https://docs.github.com/en/actions/learn-github-actions/expressions | |
| run: | | |
| pip install --upgrade --config-setting="--install-option=--no-cython-compile" cython>=3.0.0b2 | |
| - name: Install the current package (necessary for src-layout) with cythonize | |
| if: ${{ matrix.python-version == '*' }} | |
| # necessary to add --editable to install locally to be able to run the tests/* scripts, otherwise we can still run them but coverage will not detect the reedsolo files since they will be in site-packages, hence with a very different path, this is because without an editable install, with a src-layout there is no implicitly set PYTHONPATH, as described in https://setuptools.pypa.io/en/latest/userguide/package_discovery.html#src-layout | |
| run: | | |
| pip install --upgrade --editable .[test,testmeta] --config-setting="--build-option=--cythonize" --verbose | |
| - name: Install the current package (necessary for src-layout) | |
| if: ${{ matrix.python-version != '*' }} | |
| # to test locally, add --editable to the pip install command below | |
| run: | | |
| pip install --upgrade --editable .[test,testmeta] --verbose | |
| - name: Test with pytest | |
| run: | | |
| coverage run --branch -m pytest -v | |
| coverage report -m | |
| - name: Send coverage to Coveralls | |
| env: | |
| GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} | |
| if: ${{ matrix.python-version >= 3 }} | |
| run: coveralls --service=github | |
| - name: Build sdist (necessary for the other tests below) | |
| if: ${{ matrix.python-version == '*' }} | |
| run: python -sBm build --config-setting="--build-option=--cythonize" | |
| - name: Twine check | |
| if: ${{ matrix.python-version == '*' }} | |
| run: | | |
| twine check "dist/*" | |
| rstcheck README.rst | |
| - name: pyproject.toml validity | |
| if: ${{ matrix.python-version == '*' }} | |
| run: validate-pyproject pyproject.toml -v |