Python
/
ruff
mirror of https://github.com/astral-sh/ruff
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Fix `ruff-action` documentation to consistently use `args` instead of `options` (#10249)

This commit is contained in:
Micha Reiser 2024-03-06 18:09:45 +01:00 committed by GitHub
parent cbd927f346
commit fe6afbe406
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 3 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
docs/integrations.md
View File

@ -417,7 +417,7 @@ Alternatively, you can include `ruff-action` as a step in any other workflow fil
`ruff-action` accepts optional configuration parameters via `with:`, including: `ruff-action` accepts optional configuration parameters via `with:`, including:
- `version`: The Ruff version to install (default: latest). - `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: `"."`). - `src`: The source paths to pass to Ruff (default: `"."`).
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.0.259`:
@ -425,7 +425,7 @@ For example, to run `ruff check --select B ./src` using Ruff version `0.0.259`:
```yaml ```yaml
- uses: chartboost/ruff-action@v1 - uses: chartboost/ruff-action@v1
with: with:
src: "./src"
version: 0.0.259 version: 0.0.259
args: --select B args: check --select B
src: "./src"
``` ```