Skip to content

Commit

Permalink
Fix ruff-action documentation to consistently use args instead of…
Browse files Browse the repository at this point in the history
… `options` (#10249)
  • Loading branch information
MichaReiser authored Mar 6, 2024
1 parent cbd927f commit fe6afbe
Showing 1 changed file with 3 additions and 3 deletions.
6 changes: 3 additions & 3 deletions docs/integrations.md
Original file line number Diff line number Diff line change
Expand Up @@ -417,15 +417,15 @@ Alternatively, you can include `ruff-action` as a step in any other workflow fil
`ruff-action` accepts optional configuration parameters via `with:`, including:

- `version`: The Ruff version to install (default: latest).
- `options`: The command-line arguments to pass to Ruff (default: `"check"`).
- `args`: The command-line arguments to pass to Ruff (default: `"check"`).
- `src`: The source paths to pass to Ruff (default: `"."`).

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

```yaml
- uses: chartboost/ruff-action@v1
with:
src: "./src"
version: 0.0.259
args: --select B
args: check --select B
src: "./src"
```

0 comments on commit fe6afbe

Please sign in to comment.