mirror of https://github.com/astral-sh/ruff
Link to `astral-sh/ruff-action` (#13551)
This commit is contained in:
parent
bee498d635
commit
668730cc28
|
|
@ -182,7 +182,7 @@ Ruff can also be used as a [pre-commit](https://pre-commit.com/) hook via [`ruff
|
||||||
Ruff can also be used as a [VS Code extension](https://github.com/astral-sh/ruff-vscode) or with [various other editors](https://docs.astral.sh/ruff/editors/setup).
|
Ruff can also be used as a [VS Code extension](https://github.com/astral-sh/ruff-vscode) or with [various other editors](https://docs.astral.sh/ruff/editors/setup).
|
||||||
|
|
||||||
Ruff can also be used as a [GitHub Action](https://github.com/features/actions) via
|
Ruff can also be used as a [GitHub Action](https://github.com/features/actions) via
|
||||||
[`ruff-action`](https://github.com/chartboost/ruff-action):
|
[`ruff-action`](https://github.com/astral-sh/ruff-action):
|
||||||
|
|
||||||
```yaml
|
```yaml
|
||||||
name: Ruff
|
name: Ruff
|
||||||
|
|
@ -192,7 +192,7 @@ jobs:
|
||||||
runs-on: ubuntu-latest
|
runs-on: ubuntu-latest
|
||||||
steps:
|
steps:
|
||||||
- uses: actions/checkout@v4
|
- uses: actions/checkout@v4
|
||||||
- uses: chartboost/ruff-action@v1
|
- uses: astral-sh/ruff-action@v1
|
||||||
```
|
```
|
||||||
|
|
||||||
### Configuration<a id="configuration"></a>
|
### Configuration<a id="configuration"></a>
|
||||||
|
|
|
||||||
|
|
@ -25,7 +25,7 @@ jobs:
|
||||||
run: ruff check --output-format=github .
|
run: ruff check --output-format=github .
|
||||||
```
|
```
|
||||||
|
|
||||||
Ruff can also be used as a GitHub Action via [`ruff-action`](https://github.com/chartboost/ruff-action).
|
Ruff can also be used as a GitHub Action via [`ruff-action`](https://github.com/astral-sh/ruff-action).
|
||||||
|
|
||||||
By default, `ruff-action` runs as a pass-fail test to ensure that a given repository doesn't contain
|
By default, `ruff-action` runs as a pass-fail test to ensure that a given repository doesn't contain
|
||||||
any lint rule violations as per its [configuration](configuration.md).
|
any lint rule violations as per its [configuration](configuration.md).
|
||||||
|
|
@ -46,13 +46,13 @@ jobs:
|
||||||
runs-on: ubuntu-latest
|
runs-on: ubuntu-latest
|
||||||
steps:
|
steps:
|
||||||
- uses: actions/checkout@v4
|
- uses: actions/checkout@v4
|
||||||
- uses: chartboost/ruff-action@v1
|
- uses: astral-sh/ruff-action@v1
|
||||||
```
|
```
|
||||||
|
|
||||||
Alternatively, you can include `ruff-action` as a step in any other workflow file:
|
Alternatively, you can include `ruff-action` as a step in any other workflow file:
|
||||||
|
|
||||||
```yaml
|
```yaml
|
||||||
- uses: chartboost/ruff-action@v1
|
- uses: astral-sh/ruff-action@v1
|
||||||
```
|
```
|
||||||
|
|
||||||
`ruff-action` accepts optional configuration parameters via `with:`, including:
|
`ruff-action` accepts optional configuration parameters via `with:`, including:
|
||||||
|
|
@ -64,7 +64,7 @@ Alternatively, you can include `ruff-action` as a step in any other workflow fil
|
||||||
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`:
|
||||||
|
|
||||||
```yaml
|
```yaml
|
||||||
- uses: chartboost/ruff-action@v1
|
- uses: astral-sh/ruff-action@v1
|
||||||
with:
|
with:
|
||||||
version: 0.0.259
|
version: 0.0.259
|
||||||
args: check --select B
|
args: check --select B
|
||||||
|
|
|
||||||
Loading…
Reference in New Issue