Remove experimental formatter warning #20587
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: CI | |
| on: | |
| push: | |
| branches: [main] | |
| pull_request: | |
| workflow_dispatch: | |
| concurrency: | |
| group: ${{ github.workflow }}-${{ github.ref_name }}-${{ github.event.pull_request.number || github.sha }} | |
| cancel-in-progress: true | |
| env: | |
| CARGO_INCREMENTAL: 0 | |
| CARGO_NET_RETRY: 10 | |
| CARGO_TERM_COLOR: always | |
| RUSTUP_MAX_RETRIES: 10 | |
| PACKAGE_NAME: ruff | |
| PYTHON_VERSION: "3.11" | |
| jobs: | |
| determine_changes: | |
| name: "Determine changes" | |
| runs-on: ubuntu-latest | |
| outputs: | |
| linter: ${{ steps.changed.outputs.linter_any_changed }} | |
| formatter: ${{ steps.changed.outputs.formatter_any_changed }} | |
| steps: | |
| - uses: actions/checkout@v4 | |
| with: | |
| fetch-depth: 0 | |
| - uses: tj-actions/changed-files@v39 | |
| id: changed | |
| with: | |
| files_yaml: | | |
| linter: | |
| - Cargo.toml | |
| - Cargo.lock | |
| - crates/** | |
| - "!crates/ruff_python_formatter/**" | |
| - "!crates/ruff_formatter/**" | |
| - "!crates/ruff_dev/**" | |
| - "!crates/ruff_shrinking/**" | |
| - scripts/* | |
| formatter: | |
| - Cargo.toml | |
| - Cargo.lock | |
| - crates/ruff_python_formatter/** | |
| - crates/ruff_formatter/** | |
| - crates/ruff_python_trivia/** | |
| - crates/ruff_python_ast/** | |
| - crates/ruff_source_file/** | |
| - crates/ruff_python_index/** | |
| - crates/ruff_text_size/** | |
| - crates/ruff_python_parser/** | |
| - crates/ruff_dev/** | |
| - scripts/* | |
| cargo-fmt: | |
| name: "cargo fmt" | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@v4 | |
| - name: "Install Rust toolchain" | |
| run: rustup component add rustfmt | |
| - run: cargo fmt --all --check | |
| cargo-clippy: | |
| name: "cargo clippy" | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@v4 | |
| - name: "Install Rust toolchain" | |
| run: | | |
| rustup component add clippy | |
| rustup target add wasm32-unknown-unknown | |
| - uses: Swatinem/rust-cache@v2 | |
| - name: "Clippy" | |
| run: cargo clippy --workspace --all-targets --all-features -- -D warnings | |
| - name: "Clippy (wasm)" | |
| run: cargo clippy -p ruff_wasm --target wasm32-unknown-unknown --all-features -- -D warnings | |
| cargo-test: | |
| strategy: | |
| matrix: | |
| os: [ubuntu-latest, windows-latest] | |
| runs-on: ${{ matrix.os }} | |
| name: "cargo test | ${{ matrix.os }}" | |
| steps: | |
| - uses: actions/checkout@v4 | |
| - name: "Install Rust toolchain" | |
| run: rustup show | |
| - name: "Install cargo insta" | |
| uses: taiki-e/install-action@v2 | |
| with: | |
| tool: cargo-insta | |
| - uses: Swatinem/rust-cache@v2 | |
| - name: "Run tests (Ubuntu)" | |
| if: ${{ matrix.os == 'ubuntu-latest' }} | |
| run: cargo insta test --all --all-features --unreferenced reject | |
| - name: "Run tests (Windows)" | |
| if: ${{ matrix.os == 'windows-latest' }} | |
| shell: bash | |
| # We can't reject unreferenced snapshots on windows because flake8_executable can't run on windows | |
| run: cargo insta test --all --all-features | |
| # Check for broken links in the documentation. | |
| - run: cargo doc --all --no-deps | |
| env: | |
| # Setting RUSTDOCFLAGS because `cargo doc --check` isn't yet implemented (https://github.com/rust-lang/cargo/issues/10025). | |
| RUSTDOCFLAGS: "-D warnings" | |
| - uses: actions/upload-artifact@v3 | |
| if: ${{ matrix.os == 'ubuntu-latest' }} | |
| with: | |
| name: ruff | |
| path: target/debug/ruff | |
| cargo-fuzz: | |
| runs-on: ubuntu-latest | |
| name: "cargo fuzz" | |
| steps: | |
| - uses: actions/checkout@v4 | |
| - name: "Install Rust toolchain" | |
| run: rustup show | |
| - uses: Swatinem/rust-cache@v2 | |
| with: | |
| workspaces: "fuzz -> target" | |
| - name: "Install cargo-fuzz" | |
| uses: taiki-e/install-action@v2 | |
| with: | |
| tool: [email protected] | |
| - run: cargo fuzz build -s none | |
| cargo-test-wasm: | |
| runs-on: ubuntu-latest | |
| name: "cargo test (wasm)" | |
| steps: | |
| - uses: actions/checkout@v4 | |
| - name: "Install Rust toolchain" | |
| run: rustup target add wasm32-unknown-unknown | |
| - uses: actions/setup-node@v3 | |
| with: | |
| node-version: 18 | |
| cache: "npm" | |
| cache-dependency-path: playground/package-lock.json | |
| - uses: jetli/[email protected] | |
| - uses: Swatinem/rust-cache@v2 | |
| - name: "Run wasm-pack" | |
| run: | | |
| cd crates/ruff_wasm | |
| wasm-pack test --node | |
| scripts: | |
| name: "test scripts" | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@v4 | |
| - name: "Install Rust toolchain" | |
| run: rustup component add rustfmt | |
| - uses: Swatinem/rust-cache@v2 | |
| - run: ./scripts/add_rule.py --name DoTheThing --prefix PL --code C0999 --linter pylint | |
| - run: cargo check | |
| - run: cargo fmt --all --check | |
| - run: | | |
| ./scripts/add_plugin.py test --url https://pypi.org/project/-test/0.1.0/ --prefix TST | |
| ./scripts/add_rule.py --name FirstRule --prefix TST --code 001 --linter test | |
| - run: cargo check | |
| - run: cargo fmt --all --check | |
| ecosystem: | |
| name: "ecosystem" | |
| runs-on: ubuntu-latest | |
| needs: | |
| - cargo-test | |
| - determine_changes | |
| # Only runs on pull requests, since that is the only we way we can find the base version for comparison. | |
| if: github.event_name == 'pull_request' && needs.determine_changes.outputs.linter == 'true' | |
| steps: | |
| - uses: actions/checkout@v4 | |
| - uses: actions/setup-python@v4 | |
| with: | |
| python-version: ${{ env.PYTHON_VERSION }} | |
| - uses: actions/download-artifact@v3 | |
| name: Download Ruff binary | |
| id: ruff-target | |
| with: | |
| name: ruff | |
| path: target/debug | |
| - uses: dawidd6/action-download-artifact@v2 | |
| name: Download base results | |
| with: | |
| name: ruff | |
| branch: ${{ github.event.pull_request.base.ref }} | |
| check_artifacts: true | |
| - name: Run ecosystem check | |
| run: | | |
| # Make executable, since artifact download doesn't preserve this | |
| chmod +x ruff ${{ steps.ruff-target.outputs.download-path }}/ruff | |
| scripts/check_ecosystem.py ruff ${{ steps.ruff-target.outputs.download-path }}/ruff | tee ecosystem-result | |
| cat ecosystem-result > $GITHUB_STEP_SUMMARY | |
| echo ${{ github.event.number }} > pr-number | |
| - uses: actions/upload-artifact@v3 | |
| name: Upload PR Number | |
| with: | |
| name: pr-number | |
| path: pr-number | |
| - uses: actions/upload-artifact@v3 | |
| name: Upload Results | |
| with: | |
| name: ecosystem-result | |
| path: ecosystem-result | |
| cargo-udeps: | |
| name: "cargo udeps" | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@v4 | |
| - name: "Install nightly Rust toolchain" | |
| # Only pinned to make caching work, update freely | |
| run: rustup toolchain install nightly-2023-10-15 | |
| - uses: Swatinem/rust-cache@v2 | |
| - name: "Install cargo-udeps" | |
| uses: taiki-e/install-action@cargo-udeps | |
| - name: "Run cargo-udeps" | |
| run: cargo +nightly-2023-10-15 udeps | |
| python-package: | |
| name: "python package" | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@v4 | |
| - uses: actions/setup-python@v4 | |
| with: | |
| python-version: ${{ env.PYTHON_VERSION }} | |
| architecture: x64 | |
| - uses: Swatinem/rust-cache@v2 | |
| - name: "Prep README.md" | |
| run: python scripts/transform_readme.py --target pypi | |
| - name: "Build wheels" | |
| uses: PyO3/maturin-action@v1 | |
| with: | |
| args: --out dist | |
| - name: "Test wheel" | |
| run: | | |
| pip install --force-reinstall --find-links dist ${{ env.PACKAGE_NAME }} | |
| ruff --help | |
| python -m ruff --help | |
| - name: "Remove wheels from cache" | |
| run: rm -rf target/wheels | |
| pre-commit: | |
| name: "pre-commit" | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@v4 | |
| - uses: actions/setup-python@v4 | |
| with: | |
| python-version: ${{ env.PYTHON_VERSION }} | |
| - name: "Install Rust toolchain" | |
| run: rustup show | |
| - uses: Swatinem/rust-cache@v2 | |
| - name: "Install pre-commit" | |
| run: pip install pre-commit | |
| - name: "Cache pre-commit" | |
| uses: actions/cache@v3 | |
| with: | |
| path: ~/.cache/pre-commit | |
| key: pre-commit-${{ hashFiles('.pre-commit-config.yaml') }} | |
| - name: "Run pre-commit" | |
| run: | | |
| echo '```console' > $GITHUB_STEP_SUMMARY | |
| # Enable color output for pre-commit and remove it for the summary | |
| SKIP=cargo-fmt,clippy,dev-generate-all pre-commit run --all-files --show-diff-on-failure --color=always | \ | |
| tee >(sed -E 's/\x1B\[([0-9]{1,2}(;[0-9]{1,2})*)?[mGK]//g' >> $GITHUB_STEP_SUMMARY) >&1 | |
| exit_code=${PIPESTATUS[0]} | |
| echo '```' >> $GITHUB_STEP_SUMMARY | |
| exit $exit_code | |
| docs: | |
| name: "mkdocs" | |
| runs-on: ubuntu-latest | |
| env: | |
| MKDOCS_INSIDERS_SSH_KEY_EXISTS: ${{ secrets.MKDOCS_INSIDERS_SSH_KEY != '' }} | |
| steps: | |
| - uses: actions/checkout@v4 | |
| - uses: actions/setup-python@v4 | |
| - name: "Add SSH key" | |
| if: ${{ env.MKDOCS_INSIDERS_SSH_KEY_EXISTS == 'true' }} | |
| uses: webfactory/[email protected] | |
| with: | |
| ssh-private-key: ${{ secrets.MKDOCS_INSIDERS_SSH_KEY }} | |
| - name: "Install Rust toolchain" | |
| run: rustup show | |
| - uses: Swatinem/rust-cache@v2 | |
| - name: "Install Insiders dependencies" | |
| if: ${{ env.MKDOCS_INSIDERS_SSH_KEY_EXISTS == 'true' }} | |
| run: pip install -r docs/requirements-insiders.txt | |
| - name: "Install dependencies" | |
| if: ${{ env.MKDOCS_INSIDERS_SSH_KEY_EXISTS != 'true' }} | |
| run: pip install -r docs/requirements.txt | |
| - name: "Update README File" | |
| run: python scripts/transform_readme.py --target mkdocs | |
| - name: "Generate docs" | |
| run: python scripts/generate_mkdocs.py | |
| - name: "Check docs formatting" | |
| run: python scripts/check_docs_formatted.py | |
| - name: "Build Insiders docs" | |
| if: ${{ env.MKDOCS_INSIDERS_SSH_KEY_EXISTS == 'true' }} | |
| run: mkdocs build --strict -f mkdocs.insiders.yml | |
| - name: "Build docs" | |
| if: ${{ env.MKDOCS_INSIDERS_SSH_KEY_EXISTS != 'true' }} | |
| run: mkdocs build --strict -f mkdocs.generated.yml | |
| check-formatter-ecosystem: | |
| name: "Formatter ecosystem and progress checks" | |
| runs-on: ubuntu-latest | |
| needs: determine_changes | |
| if: needs.determine_changes.outputs.formatter == 'true' || github.ref == 'refs/heads/main' | |
| steps: | |
| - uses: actions/checkout@v4 | |
| - name: "Install Rust toolchain" | |
| run: rustup show | |
| - name: "Cache rust" | |
| uses: Swatinem/rust-cache@v2 | |
| - name: "Formatter progress" | |
| run: scripts/formatter_ecosystem_checks.sh | |
| - name: "Github step summary" | |
| run: cat target/progress_projects_stats.txt > $GITHUB_STEP_SUMMARY | |
| - name: "Remove checkouts from cache" | |
| run: rm -r target/progress_projects | |
| benchmarks: | |
| runs-on: ubuntu-latest | |
| steps: | |
| - name: "Checkout Branch" | |
| uses: actions/checkout@v4 | |
| - name: "Install Rust toolchain" | |
| run: rustup show | |
| - name: "Install codspeed" | |
| uses: taiki-e/install-action@v2 | |
| with: | |
| tool: cargo-codspeed | |
| - uses: Swatinem/rust-cache@v2 | |
| - name: "Build benchmarks" | |
| run: cargo codspeed build --features codspeed -p ruff_benchmark | |
| - name: "Run benchmarks" | |
| uses: CodSpeedHQ/action@v1 | |
| with: | |
| run: cargo codspeed run | |
| token: ${{ secrets.CODSPEED_TOKEN }} |