fix: Improve compatiblity with restrictive shell environments #5672
Workflow file for this run
This file contains hidden or 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 | |
| # https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#concurrency | |
| concurrency: | |
| group: ${{ github.workflow }}-${{ github.event.pull_request.number || github.ref }} | |
| cancel-in-progress: true | |
| on: | |
| create: # is used for publishing to PyPI and TestPyPI | |
| tags: # any tag regardless of its name, no branches | |
| - "**" | |
| merge_group: | |
| branches: | |
| - "main" | |
| push: # only publishes pushes to the main branch to TestPyPI | |
| branches: # any integration branch but not tag | |
| - "main" | |
| pull_request: | |
| branches: | |
| - "main" | |
| schedule: | |
| - cron: "0 0 * * *" | |
| jobs: | |
| pre: | |
| name: pre | |
| runs-on: ubuntu-24.04 | |
| outputs: | |
| matrix: ${{ steps.generate_matrix.outputs.matrix }} | |
| steps: | |
| - name: Determine matrix | |
| id: generate_matrix | |
| uses: ansible/actions/matrix@main | |
| with: | |
| min_python: "3.10" | |
| max_python: "3.13" | |
| default_python: "3.11" # used by jobs in other_names | |
| other_names: | | |
| lint | |
| docs | |
| platforms: linux,macos | |
| tox: | |
| name: ${{ matrix.name }} / python ${{ matrix.python_version }} | |
| permissions: | |
| contents: read | |
| id-token: write # codecov actions | |
| checks: read # codecov actions | |
| runs-on: ubuntu-24.04 | |
| needs: pre | |
| strategy: | |
| fail-fast: false | |
| matrix: ${{ fromJson(needs.pre.outputs.matrix) }} | |
| steps: | |
| - uses: actions/checkout@v6 | |
| with: | |
| fetch-depth: 0 # needed by setuptools-scm | |
| - name: Cache container images | |
| if: ${{ startsWith(matrix.name, 'py') }} | |
| uses: actions/cache@v4 | |
| with: | |
| path: | | |
| ~/.local/share/containers | |
| key: ${{ runner.os }}-${{ hashFiles('src/ansible_navigator/data/images_dockerfile') }} | |
| - name: Set up Python ${{ matrix.python_version }} | |
| uses: actions/setup-python@v6 | |
| with: | |
| python-version: ${{ matrix.python_version }} | |
| cache: pip | |
| cache-dependency-path: .config/constraints.txt | |
| - name: Install tox | |
| run: python3 -m pip install --upgrade "tox>=4.0.2" | |
| - name: Log Python info (${{ matrix.python_version }}) | |
| run: | | |
| command -v python | |
| python --version --version | |
| python3 -m pip freeze --all | |
| - run: ${{ matrix.command }} | |
| - run: ${{ matrix.command2 }} | |
| if: ${{ matrix.command2 }} | |
| - run: ${{ matrix.command3 }} | |
| if: ${{ matrix.command3 }} | |
| - run: ${{ matrix.command4 }} | |
| if: ${{ matrix.command4 }} | |
| - run: ${{ matrix.command5 }} | |
| if: ${{ matrix.command5 }} | |
| - name: tox -e no-test-deps | |
| if: ${{ startsWith(matrix.name, 'py') }} | |
| continue-on-error: ${{ matrix.devel || false }} | |
| run: python3 -m tox -e no-test-deps | |
| - name: Archive logs and coverage data | |
| if: ${{ !cancelled() }} | |
| uses: coactions/upload-artifact@v4 | |
| with: | |
| name: logs-${{ matrix.name }}.zip | |
| include-hidden-files: true | |
| path: | | |
| .tox/**/coverage.xml | |
| - name: Upload test results to Codecov | |
| if: ${{ !cancelled() && hashFiles('junit.xml') != '' }} | |
| uses: codecov/test-results-action@v1 | |
| with: | |
| fail_ci_if_error: true | |
| name: ${{ matrix.name }} | |
| # unable to use wildcards yet due to https://github.com/codecov/test-results-action/issues/110 | |
| flags: ${{ matrix.python_version }},${{ matrix.os }} | |
| use_oidc: ${{ !(github.event_name == 'pull_request' && github.event.pull_request.head.repo.fork) }} | |
| - name: Change accessibility for cache | |
| if: ${{ startsWith(matrix.name, 'py') }} | |
| run: podman unshare chmod -R 755 ~/.local/share/containers/ | |
| - 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() | |
| permissions: | |
| contents: read | |
| id-token: write | |
| checks: read | |
| needs: | |
| - tox | |
| runs-on: ubuntu-24.04 | |
| steps: | |
| # checkout needed for codecov action which needs codecov.yml file | |
| - uses: actions/checkout@v6 | |
| - name: Set up Python | |
| uses: actions/setup-python@v6 | |
| with: | |
| python-version: "3.14" | |
| - run: pip3 install 'coverage>=7.5.1' | |
| - name: Merge logs into a single archive | |
| uses: actions/upload-artifact/merge@v5 | |
| with: | |
| name: logs.zip | |
| include-hidden-files: true | |
| pattern: logs-*.zip | |
| separate-directories: true | |
| - name: Download artifacts | |
| uses: actions/download-artifact@v6 | |
| with: | |
| name: logs.zip | |
| path: . | |
| - name: Upload coverage data | |
| uses: codecov/[email protected] | |
| with: | |
| name: ${{ matrix.name }} | |
| fail_ci_if_error: true | |
| use_oidc: ${{ !(github.event_name == 'pull_request' && github.event.pull_request.head.repo.fork) }} | |
| - name: Delete Merged Artifacts | |
| uses: actions/upload-artifact/merge@v5 | |
| with: | |
| include-hidden-files: true | |
| delete-merged: true | |
| - name: Check for expected number of coverage.xml reports | |
| run: | | |
| JOBS_PRODUCING_COVERAGE=6 | |
| if [ "$(find . -name coverage.xml | wc -l | bc)" -ne "${JOBS_PRODUCING_COVERAGE}" ]; then | |
| echo "::warning::Number of coverage.xml files was not the expected one (${JOBS_PRODUCING_COVERAGE}): $(find . -name coverage.xml | xargs echo)" | |
| fi | |
| - name: Decide whether the needed jobs succeeded or failed | |
| uses: re-actors/alls-green@release/v1 | |
| with: | |
| jobs: ${{ toJSON(needs) }} | |
| - name: Notify repository owners about changes affecting them | |
| uses: sourcegraph/[email protected] | |
| env: | |
| GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} | |
| # https://github.com/sourcegraph/codenotify/issues/19 | |
| continue-on-error: true |