Docs: Fix commands given in the examples #50
Workflow file for this run
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: Run all tox jobs using Python3 | |
| on: | |
| pull_request: | |
| push: | |
| branches: | |
| - main | |
| workflow_dispatch: | |
| jobs: | |
| build: | |
| runs-on: ubuntu-latest | |
| strategy: | |
| matrix: | |
| python-version: ["3.9", "3.10", "3.11", "3.12"] | |
| min_versions: ["min_versions", "latest_versions"] | |
| exclude: | |
| - min_versions: "min_versions" | |
| include: | |
| - python-version: "3.9" | |
| min_versions: "min_versions" | |
| steps: | |
| - uses: actions/checkout@v4 | |
| - name: Set up Python ${{ matrix.python-version }} | |
| uses: actions/setup-python@v5 | |
| with: | |
| python-version: ${{ matrix.python-version }} | |
| - name: Get current month | |
| id: date | |
| run: echo "date=$(date +'%Y-%m')" >> $GITHUB_OUTPUT | |
| - name: Cache APT Packages | |
| # This action should only be used when you need extra system packages | |
| uses: awalsh128/cache-apt-pkgs-action@latest | |
| with: | |
| packages: graphviz poppler-utils | |
| version: 1.0 | |
| execute_install_scripts: true | |
| - name: Cache tox and precommit environments | |
| uses: actions/cache@v4 | |
| with: | |
| path: | | |
| .tox | |
| ~/.cache/pre-commit | |
| key: ${{ runner.os }}-${{ matrix.python-version }}-${{ steps.date.outputs.date }}-${{ hashFiles('setup.py') }}-${{ hashFiles('.pre-commit-config.yaml') }} | |
| - name: Register dot plugin | |
| # This step should only be used when you need dot / graphviz | |
| run: | | |
| sudo dot -c | |
| - name: Clear results in tox environments | |
| run: | | |
| rm -rf .tox/*/tmp | |
| - name: Run tox with latest versions | |
| if: ${{ matrix.min_versions == 'latest_versions' }} | |
| run: | | |
| python -m pip install --upgrade pip setuptools | |
| pip install tox-gh-actions | |
| tox | |
| - name: Run tox with min versions | |
| if: ${{ matrix.min_versions == 'min_versions' }} | |
| run: | | |
| python -m pip install --upgrade pip setuptools | |
| pip install tox | |
| tox run -e min_versions | |
| - name: JUnit Report Action | |
| uses: mikepenz/action-junit-report@v5 | |
| if: always() # always run even if the previous step fails | |
| with: | |
| report_paths: 'reports/pytest-*.xml' | |
| - name: Upload to codecov | |
| uses: codecov/codecov-action@v5 | |
| with: | |
| fail_ci_if_error: false | |
| directory: ./reports | |
| flags: pytest | |
| name: "synthesis-workflow-py${{ matrix.python-version }}-${{ matrix.min_versions }}" | |
| token: ${{ secrets.CODECOV_TOKEN }} | |
| - name: Upload test artifacts | |
| uses: actions/upload-artifact@v4 | |
| if: always() | |
| with: | |
| name: tests-${{ matrix.python-version }}-${{ matrix.min_versions }} | |
| retention-days: 4 | |
| path: | | |
| .tox/py*/tmp | |
| docs/build | |
| reports |