[Enhencement] - Add Ruff to GitHub Actions #12
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: Lint | |
| on: | |
| pull_request: | |
| workflow_dispatch: | |
| push: | |
| branches: | |
| - main | |
| - master | |
| permissions: | |
| contents: read | |
| jobs: | |
| changed_files: | |
| runs-on: ubuntu-latest | |
| name: Test changed-files | |
| steps: | |
| - uses: actions/checkout@v4 | |
| # ----------------------------------------------------------------------------------------------------------- | |
| # Example 1 | |
| # ----------------------------------------------------------------------------------------------------------- | |
| - name: Get changed files | |
| id: changed-files | |
| uses: tj-actions/changed-files@24d32ffd492484c1d75e0c0b894501ddb9d30d62 # v47 | |
| # To compare changes between the current commit and the last pushed remote commit set `since_last_remote_commit: true`. e.g | |
| # with: | |
| # since_last_remote_commit: true | |
| - name: List all changed files | |
| env: | |
| ALL_CHANGED_FILES: ${{ steps.changed-files.outputs.all_changed_files }} | |
| run: | | |
| for file in ${ALL_CHANGED_FILES}; do | |
| echo "$file was changed" | |
| done | |
| # ----------------------------------------------------------------------------------------------------------- | |
| # Example 2 | |
| # ----------------------------------------------------------------------------------------------------------- | |
| - name: Get all changed markdown files | |
| id: changed-markdown-files | |
| uses: tj-actions/changed-files@24d32ffd492484c1d75e0c0b894501ddb9d30d62 # v47 | |
| with: | |
| # Avoid using single or double quotes for multiline patterns | |
| files: | | |
| **.md | |
| docs/**.md | |
| - name: List all changed files markdown files | |
| if: steps.changed-markdown-files.outputs.any_changed == 'true' | |
| env: | |
| ALL_CHANGED_FILES: ${{ steps.changed-markdown-files.outputs.all_changed_files }} | |
| run: | | |
| for file in ${ALL_CHANGED_FILES}; do | |
| echo "$file was changed" | |
| done | |
| # ----------------------------------------------------------------------------------------------------------- | |
| # Example 3 | |
| # ----------------------------------------------------------------------------------------------------------- | |
| - name: Get all test, doc and src files that have changed | |
| id: changed-files-yaml | |
| uses: tj-actions/changed-files@24d32ffd492484c1d75e0c0b894501ddb9d30d62 # v47 | |
| with: | |
| files_yaml: | | |
| doc: | |
| - '**.md' | |
| - docs/** | |
| test: | |
| - test/** | |
| - '!test/**.md' | |
| src: | |
| - src/** | |
| # Optionally set `files_yaml_from_source_file` to read the YAML from a file. e.g `files_yaml_from_source_file: .github/changed-files.yml` | |
| - name: Run step if test file(s) change | |
| # NOTE: Ensure all outputs are prefixed by the same key used above e.g. `test_(...)` | `doc_(...)` | `src_(...)` when trying to access the `any_changed` output. | |
| if: steps.changed-files-yaml.outputs.test_any_changed == 'true' | |
| env: | |
| TEST_ALL_CHANGED_FILES: ${{ steps.changed-files-yaml.outputs.test_all_changed_files }} | |
| run: | | |
| echo "One or more test file(s) has changed." | |
| echo "List all the files that have changed: $TEST_ALL_CHANGED_FILES" | |
| - name: Run step if doc file(s) change | |
| if: steps.changed-files-yaml.outputs.doc_any_changed == 'true' | |
| env: | |
| DOC_ALL_CHANGED_FILES: ${{ steps.changed-files-yaml.outputs.doc_all_changed_files }} | |
| run: | | |
| echo "One or more doc file(s) has changed." | |
| echo "List all the files that have changed: $DOC_ALL_CHANGED_FILES" | |
| # ----------------------------------------------------------------------------------------------------------- | |
| # Example 4 | |
| # ----------------------------------------------------------------------------------------------------------- | |
| - name: Get changed files in the docs folder | |
| id: changed-files-specific | |
| uses: tj-actions/changed-files@24d32ffd492484c1d75e0c0b894501ddb9d30d62 # v47 | |
| with: | |
| files: docs/*.{js,html} # Alternatively using: `docs/**` | |
| files_ignore: docs/static.js | |
| - name: Run step if any file(s) in the docs folder change | |
| if: steps.changed-files-specific.outputs.any_changed == 'true' | |
| env: | |
| ALL_CHANGED_FILES: ${{ steps.changed-files-specific.outputs.all_changed_files }} | |
| run: | | |
| echo "One or more files in the docs folder has changed." | |
| echo "List all the files that have changed: $ALL_CHANGED_FILES" | |
| - uses: actions/checkout@v2 | |
| - uses: actions/setup-python@v3 | |
| with: | |
| python-version: '3.x' | |
| - run: pip install mypy | |
| - name: Get Python changed files | |
| id: changed-py-files | |
| uses: tj-actions/changed-files@v23 | |
| with: | |
| files: | | |
| *.py | |
| **/*.py | |
| - name: Run if any of the listed files above is changed | |
| if: steps.changed-py-files.outputs.any_changed == 'true' | |
| run: mypy ${{ steps.changed-py-files.outputs.all_changed_files }} --ignore-missing-imports | |
| lint: | |
| runs-on: ubuntu-latest | |
| steps: | |
| - name: Checkout code | |
| uses: actions/checkout@v5 | |
| - name: Set up Python | |
| uses: actions/setup-python@v6 | |
| with: | |
| python-version: ${{ matrix.python-version }} | |
| - name: Install Ruff | |
| run: pip install ruff | |
| - name: Run Ruff | |
| run: ruff check $(git diff --name-only --cached -- '*.py') |