ruff-action

KO | EN

gitlite — search

#javascript #python #hacktoberfest #ai #typescript #machine-learning #rust #linux #macos #windows #awesome #cli #security #openai

(★ 127)

A GitHub Action for Ruff

File Explorer

Download Latest Version (.zip)

- - actionlint.yml
  - python.yml
  - stale.yml
- dependabot.yml
- main.py
.gitignore
.pre-commit-config.yaml
action.yml
LICENSE
pyproject.toml
README.md

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

> [!WARNING]  
> This repository is no longer actively maintained. It is strongly suggested that you use the [officially-supported Ruff action from Astral](https://github.com/astral-sh/ruff-action).

# ruff-action
A GitHub Action for Ruff

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://docs.astral.sh/ruff/rules/) specified in your configuration.  Though it runs `ruff`, the action can do anything `ruff` can (ex, fix).

## Compatibility
This action is known to support all GitHub-hosted runner OSes.  It likely can run on self-hosted runners, but might need specific dependencies. Only published versions of Ruff are supported (i.e. whatever is available on PyPI).

## Basic Usage
Create a file (ex: `.github/workflows/ruff.yml`) inside your repository with:

```yaml
name: Ruff
on: [push, pull_request]
jobs:
  ruff:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
      - uses: chartboost/ruff-action@v1
```

## Advanced Usage
The Ruff action can be customized via optional configuration parameters passed to Ruff (using `with:`):

- 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: You can specify the arguments to pass to the ruff command. By default, it's `check`.
- src: default, '.'

See [Configuring Ruff](https://github.com/astral-sh/ruff/blob/main/docs/configuration.md) for details

### Use a different ruff version
```yaml
- uses: chartboost/ruff-action@v1
  with:
    version: 0.2.2
```

### Specify a different source directory
```yaml
- uses: chartboost/ruff-action@v1
  with:
    src: './src'
```

### Use `ruff format`
```yaml
- uses: chartboost/ruff-action@v1
  with:
    args: 'format --check'
```

### Only run ruff on changed files
```yaml
- uses: chartboost/ruff-action@v1
  with:
    changed-files: 'true'
```

ruff-action

File Explorer

Today's picks

Was this content helpful?

Recent Feedback

ruff-action

File Explorer

Today's picks

Was this content helpful?

Recent Feedback

Download README