actions/ruff
1
0
Fork 0
mirror of https://github.com/astral-sh/ruff-action.git synced 2026-05-21 16:30:14 +02:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #15 from cclauss/patch-2

Browse Source 
README.md: Update the Ruff version
This commit is contained in:
brucearctor
2024-02-17 17:37:23 -08:00
committed by GitHub
parent a0f145b455 5619897516
commit 41f0574bbd
1 changed files with 5 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+5 -5
View File
@@ -4,7 +4,7 @@ A GitHub Action for Ruff
Ruff can now be used as a [GitHub Action](https://github.com/features/actions). Ruff can now be used as a [GitHub Action](https://github.com/features/actions).
This action is commonly used as a pass/fail test to ensure your repository stays clean, abiding the [Rules](https://beta.ruff.rs/docs/rules/) specified in your configuration. Though it runs `ruff` so the action can do anything `ruff` can (ex: fix). This action is commonly used as a pass/fail test to ensure your repository stays clean, abiding the [Rules](https://beta.ruff.rs/docs/rules/) specified in your configuration. Though it runs `ruff`, the action can do anything `ruff` can (ex, fix).
Compatibility Compatibility
This action is known to support all GitHub-hosted runner OSes. In addition, only published versions of Ruff are supported (i.e. whatever is available on PyPI). This action is known to support all GitHub-hosted runner OSes. In addition, only published versions of Ruff are supported (i.e. whatever is available on PyPI).
@@ -19,7 +19,7 @@ jobs:
ruff: ruff:
runs-on: ubuntu-latest runs-on: ubuntu-latest
steps: steps:
- uses: actions/checkout@v3 - uses: actions/checkout@v4
- uses: chartboost/ruff-action@v1 - uses: chartboost/ruff-action@v1
``` ```
@@ -31,15 +31,15 @@ can be included as a step in any other workflow file.
The Ruff action can be customized via optional configuration parameters passed to Ruff (using `with:`): The Ruff action can be customized via optional configuration parameters passed to Ruff (using `with:`):
- version: Must be release available on PyPI. default, latest release of ruff. You can pin a version, or use any valid version specifier. - version: Must be a Ruff release available on PyPI. By default, latest release of Ruff. You can pin a version, or use any valid version specifier.
- args: default,`check` - args: default, `check`
- src: default, '.' - src: default, '.'
```yaml ```yaml
- uses: chartboost/ruff-action@v1 - uses: chartboost/ruff-action@v1
with: with:
src: "./src" src: "./src"
version: 0.0.259 version: 0.2.2
args: --select B args: --select B
``` ```