Skip to content

Commit

Permalink
docs/integrations.md: Upgrade example to astral-sh/ruff-action@v2 (as…
Browse files Browse the repository at this point in the history
…tral-sh#14800)

<!--
Thank you for contributing to Ruff! To help us out with reviewing,
please consider the following:

- Does this pull request include a summary of the change? (See below.)
- Does this pull request include a descriptive title?
- Does this pull request include references to any relevant issues?
-->

## Summary

https://docs.astral.sh/ruff/integrations/#github-actions upgraded for
https://github.com/astral-sh/ruff-action/releases

<!-- What's the purpose of the change? What does it do, and why? -->

## Test Plan

<!-- How was it tested? -->
@eifinger Your review, please.
  • Loading branch information
cclauss authored Dec 6, 2024
1 parent 40b0b67 commit 5aab57b
Showing 1 changed file with 5 additions and 5 deletions.
10 changes: 5 additions & 5 deletions docs/integrations.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,13 +46,13 @@ jobs:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- uses: astral-sh/ruff-action@v1
- uses: astral-sh/ruff-action@v2
```

Alternatively, you can include `ruff-action` as a step in any other workflow file:

```yaml
- uses: astral-sh/ruff-action@v1
- uses: astral-sh/ruff-action@v2
```

`ruff-action` accepts optional configuration parameters via `with:`, including:
Expand All @@ -61,12 +61,12 @@ Alternatively, you can include `ruff-action` as a step in any other workflow fil
- `args`: The command-line arguments to pass to Ruff (default: `"check"`).
- `src`: The source paths to pass to Ruff (default: `[".", "src"]`).

For example, to run `ruff check --select B ./src` using Ruff version `0.0.259`:
For example, to run `ruff check --select B ./src` using Ruff version `0.8.0`:

```yaml
- uses: astral-sh/ruff-action@v1
- uses: astral-sh/ruff-action@v2
with:
version: 0.0.259
version: 0.8.0
args: check --select B
src: "./src"
```
Expand Down

0 comments on commit 5aab57b

Please sign in to comment.