Update documentation #3503
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: tox | |
| on: | |
| push: # only publishes pushes to the main branch to TestPyPI | |
| branches: # any integration branch but not tag | |
| - "main" | |
| pull_request: | |
| branches: | |
| - "main" | |
| concurrency: | |
| group: ${{ github.workflow }}-${{ github.event.pull_request.number || github.sha }} | |
| cancel-in-progress: true | |
| env: | |
| FORCE_COLOR: 1 # tox, pytest, ansible-lint | |
| PY_COLORS: 1 | |
| jobs: | |
| pre: | |
| name: pre | |
| runs-on: ubuntu-22.04 | |
| outputs: | |
| matrix: ${{ steps.generate_matrix.outputs.matrix }} | |
| steps: | |
| - name: Determine matrix | |
| id: generate_matrix | |
| uses: coactions/dynamic-matrix@v1 | |
| with: | |
| min_python: "3.9" | |
| max_python: "3.11" | |
| other_names: | | |
| lint | |
| docs | |
| pkg | |
| eco | |
| py311-devel | |
| build: | |
| name: ${{ matrix.name }} | |
| runs-on: ${{ matrix.os || 'ubuntu-22.04' }} | |
| needs: pre | |
| defaults: | |
| run: | |
| shell: ${{ matrix.shell || 'bash'}} | |
| # limit potential endless looks like we had with build-containers | |
| timeout-minutes: 20 | |
| strategy: | |
| fail-fast: false | |
| matrix: ${{ fromJson(needs.pre.outputs.matrix) }} | |
| env: | |
| PYTEST_REQPASS: 445 | |
| steps: | |
| - uses: actions/checkout@v3 | |
| with: | |
| fetch-depth: 0 # needed by setuptools-scm | |
| submodules: true | |
| - name: Set pre-commit cache | |
| uses: actions/cache@v3 | |
| if: ${{ matrix.passed_name == 'lint' }} | |
| with: | |
| path: | | |
| ~/.cache/pre-commit | |
| key: pre-commit-${{ matrix.name || matrix.passed_name }}-${{ hashFiles('.pre-commit-config.yaml') }} | |
| - name: Install system dependencies | |
| # remove broken .deb ansible and replace with pip version: | |
| # https://github.com/actions/virtual-environments/issues/3001 | |
| run: | | |
| sudo apt-get remove -y ansible \ | |
| && sudo apt-get update \ | |
| && sudo apt-get install -y libvirt-dev python3-cryptography python3-jinja2 python3-yaml virtualenv \ | |
| && pip3 install --user ansible-core ansible-lint\ | |
| && echo "$HOME/.local/bin" >> $GITHUB_PATH | |
| # https://docs.github.com/en/actions/reference/workflow-commands-for-github-actions#adding-a-system-path | |
| - name: Validate that ansible works | |
| run: | | |
| ansible --version \ | |
| && virtualenv foo \ | |
| && source foo/bin/activate \ | |
| && ansible --version | |
| - name: Set up Python ${{ matrix.python_version || '3.9' }} | |
| if: "!contains(matrix.shell, 'wsl')" | |
| uses: actions/setup-python@v4 | |
| with: | |
| cache: pip | |
| python-version: ${{ matrix.python_version || '3.9' }} | |
| - name: Install tox | |
| run: | | |
| python3 -m pip install --upgrade pip | |
| python3 -m pip install --upgrade "tox>=4.0.0" | |
| - name: Log installed dists | |
| run: python3 -m pip freeze --all | |
| - name: Initialize tox envs ${{ matrix.passed_name }} | |
| run: python3 -m tox --notest --skip-missing-interpreters false -vv -e ${{ matrix.passed_name }} | |
| timeout-minutes: 5 # average is under 1, but macos can be over 3 | |
| # sequential run improves browsing experience (almost no speed impact) | |
| - name: tox -e ${{ matrix.passed_name }} | |
| run: python3 -m tox -e ${{ matrix.passed_name }} | |
| - name: Combine coverage data | |
| if: ${{ startsWith(matrix.passed_name, 'py') }} | |
| # produce a single .coverage file at repo root | |
| run: tox -e coverage | |
| - name: Upload coverage data | |
| if: ${{ startsWith(matrix.passed_name, 'py') }} | |
| uses: codecov/codecov-action@v3 | |
| with: | |
| name: ${{ matrix.passed_name }} | |
| fail_ci_if_error: false # see https://github.com/codecov/codecov-action/issues/598 | |
| token: ${{ secrets.CODECOV_TOKEN }} | |
| verbose: true # optional (default = false) | |
| - name: Report failure if git reports dirty status | |
| run: | | |
| if [[ -n $(git status -s) ]]; then | |
| # shellcheck disable=SC2016 | |
| echo -n '::error file=git-status::' | |
| printf '### Failed as git reported modified and/or untracked files\n```\n%s\n```\n' "$(git status -s)" | tee -a "$GITHUB_STEP_SUMMARY" | |
| exit 99 | |
| fi | |
| # https://github.com/actions/toolkit/issues/193 | |
| check: | |
| if: always() | |
| needs: | |
| - build | |
| 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) }} |