https://github.com/jpetrucciani/ruff-check

github action to run ruff on your repo
https://github.com/jpetrucciani/ruff-check

actions lint python ruff static-analysis

Last synced: 7 days ago
JSON representation

github action to run ruff on your repo

• Host: GitHub
• URL: https://github.com/jpetrucciani/ruff-check
• Owner: jpetrucciani
• License: mit
• Created: 2023-01-23T15:20:17.000Z (almost 2 years ago)
• Default Branch: main
• Last Pushed: 2024-04-25T18:08:29.000Z (7 months ago)
• Last Synced: 2024-05-02T02:17:30.268Z (7 months ago)
• Topics: actions, lint, python, ruff, static-analysis
• Language: Dockerfile
• Homepage:
• Size: 80.1 KB
• Stars: 12
• Watchers: 3
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# ruff-check

GitHub Action for [ruff](https://github.com/charliermarsh/ruff)

## Inputs

### `path`

The path to run ruff on

**Default** `"."`

### `format`

Format to output ruff messages in

**Default** `"github"`

### `flags`

**Optional** Optional ruff flags (refer to `ruff --help`)

**Default** `""`

## Outputs

None

## Example usage

```yaml

uses: jpetrucciani/ruff-check@main

# or specify a path!

uses: jpetrucciani/ruff-check@main

with:

  path: '.'

# or specify more flags!

uses: jpetrucciani/ruff-check@main

with:

  flags: '--exclude ./env/'

```