-
Notifications
You must be signed in to change notification settings - Fork 112
chore: use reusable tox workflow #2057
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Draft
ssbarnea
wants to merge
2
commits into
main
Choose a base branch
from
fix/gha
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Draft
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,198 +1,35 @@ | ||
| 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 | ||
| push: | ||
| branches: | ||
| - "main" | ||
| pull_request: | ||
| branches: | ||
| - "main" | ||
| schedule: | ||
| - cron: "0 0 * * *" | ||
| workflow_call: | ||
| concurrency: | ||
| group: ${{ github.workflow }}-${{ github.event.pull_request.number || github.sha }} | ||
| cancel-in-progress: true | ||
|
|
||
| jobs: | ||
| pre: | ||
| name: pre | ||
| runs-on: ubuntu-24.04 | ||
| outputs: | ||
| matrix: ${{ steps.generate_matrix.outputs.matrix }} | ||
| steps: | ||
| - name: Determine matrix | ||
| id: generate_matrix | ||
| uses: coactions/dynamic-matrix@v4 | ||
| 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@v5 | ||
| 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@v5 | ||
|
|
||
| - name: Set up Python | ||
| uses: actions/setup-python@v6 | ||
| with: | ||
| python-version: "3.13" | ||
|
|
||
| - run: pip3 install 'coverage>=7.5.1' | ||
|
|
||
| - name: Merge logs into a single archive | ||
| uses: actions/upload-artifact/merge@v4 | ||
| with: | ||
| name: logs.zip | ||
| include-hidden-files: true | ||
| pattern: logs-*.zip | ||
| separate-directories: true | ||
|
|
||
| - name: Download artifacts | ||
| uses: actions/download-artifact@v5 | ||
| 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@v4 | ||
| 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 | ||
| uses: ansible/team-devtools/.github/workflows/tox.yml@main | ||
| secrets: inherit | ||
| with: | ||
| min_python: "3.10" | ||
| default_python: "3.13" | ||
| max_python: "3.13" | ||
| other_names: | | ||
| pkg | ||
| lint | ||
| docs | ||
| py314-devel | ||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Check warning
Code scanning / CodeQL
Workflow does not contain permissions Medium
Copilot Autofix
AI about 2 months ago
To fix the problem, insert a
permissions:section at the root of the workflow, immediately after thename:(and beforeon:), limiting the permissions of the GITHUB_TOKEN to the minimum needed. Since this workflow delegates the actual job to a remote workflow, it is safest to set a minimal default here, such ascontents: read. If more specific write privileges are needed, they should be added as required. In this case, addingpermissions: contents: readat the start of the workflow should mitigate the risk and adhere to CodeQL's recommendation.