Documentation - Fix a bunch of typos, and improve certain parts of the documentation #3309
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 is our full unit tests | |
| # Self-hosted, run on an old notebook | |
| name: Unit testing | |
| on: | |
| push: | |
| branches: [development, maintenance] | |
| pull_request: | |
| branches: [development, maintenance] | |
| workflow_dispatch: | |
| jobs: | |
| build: | |
| name: Unit tests | |
| runs-on: self-hosted | |
| strategy: | |
| matrix: | |
| os: [ubuntu-latest] | |
| python-version: ['3.9.13', '3.10', '3.11', '3.12', '3.13'] | |
| architecture: ['x64'] | |
| steps: | |
| - uses: actions/checkout@v3 | |
| - name: Setup Python | |
| uses: actions/setup-python@v4 | |
| with: | |
| python-version: ${{ matrix.python-version }} | |
| - name: Install dependencies part 1 | |
| run: | | |
| rm -rf .venv | |
| python -m venv .venv | |
| source .venv/bin/activate | |
| pip install --upgrade pip | |
| python -m pip install -U pip wheel setuptools | |
| - name: Install dependencies part 2 | |
| run: | | |
| source .venv/bin/activate | |
| python -m pip install -I -e .[testing_libraries] | |
| - name: Test with pytest | |
| run: | | |
| source .venv/bin/activate | |
| which python | |
| python -c "import pyglet; print('pyglet version', pyglet.__version__)" | |
| python -c "import PIL; print('Pillow version', PIL.__version__)" | |
| pytest --maxfail=10 | |
| # Prepare the Pull Request Payload artifact. If this fails, we | |
| # we fail silently using the `continue-on-error` option. It's | |
| # nice if this succeeds, but if it fails for any reason, it | |
| # does not mean that our main workflow has failed. | |
| - name: Prepare Pull Request Payload artifact | |
| id: prepare-artifact | |
| if: always() && github.event_name == 'pull_request' | |
| continue-on-error: true | |
| run: cat $GITHUB_EVENT_PATH | jq '.pull_request' > pull_request_payload.json | |
| # This only makes sense if the previous step succeeded. To | |
| # get the original outcome of the previous step before the | |
| # `continue-on-error` conclusion is applied, we use the | |
| # `.outcome` value. This step also fails silently. | |
| - name: Upload a Build Artifact | |
| if: always() && steps.prepare-artifact.outcome == 'success' | |
| continue-on-error: true | |
| uses: actions/upload-artifact@v3 | |
| with: | |
| name: pull-request-payload | |
| path: pull_request_payload.json |