Skip to content

Commit

Permalink
Update some documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
charliermarsh committed Sep 29, 2024
1 parent beb1d37 commit ad8ad9e
Show file tree
Hide file tree
Showing 4 changed files with 10 additions and 14 deletions.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,8 @@
>
> This Action is a fork of
> [chartboost/ruff-action](https://github.com/ChartBoost/ruff-action), which is
> no longer maintained. The Action is largely unchanged, but will be updated in
> a future major release.
> no longer maintained. The Action is largely unchanged, but will be overhauled
> in a future major release.
A [GitHub Action](https://github.com/features/actions) to run
[Ruff](https://github.com/astral-sh/ruff).
Expand Down
16 changes: 7 additions & 9 deletions action.yml
Original file line number Diff line number Diff line change
@@ -1,23 +1,21 @@
name: "Ruff GH Action"
description: "A GH Action of Ruff, the extremely fast Python linter."
author: "The Ruff Community"
name: "ruff-action"
description: "A GitHub Action to run Ruff, an extremely fast Python linter and code formatter."
author: "astral-sh"
inputs:
args:
description:
"Arguments passed to Ruff. Use `ruff --help` to see available options.
Default: 'check'"
description: "Arguments passed to Ruff. Use `ruff --help` to see available options. Defaults to `check`."
required: false
default: "check"
src:
description: "Source to run ruff. Default: '.'"
description: "Source to run Ruff. Defaults to the current directory."
required: false
default: "."
version:
description: 'The version of ruff to use, e.g. "0.0.259"'
description: 'The version of Ruff to use, e.g., `0.6.0` Defaults to the latest version.'
required: false
default: ""
changed-files:
description: 'Whether to only run ruff on changed files. Default: false'
description: 'Whether to only run Ruff on changed files. Defaults to `false`.'
required: false
default: "false"
branding:
Expand Down
2 changes: 1 addition & 1 deletion action/main.py
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@

req = f"ruff{version_specifier}"

# If CHANGED_FILES is not empty, split it into a list; otherwise, use SRC
# If `CHANGED_FILES` is not empty, split it into a list; otherwise, use `SRC`.
files_to_check = shlex.split(CHANGED_FILES or SRC)

proc = run(["pipx", "run", req, *shlex.split(ARGS), *files_to_check])
Expand Down
2 changes: 0 additions & 2 deletions pyproject.toml
Original file line number Diff line number Diff line change
@@ -1,5 +1,3 @@


[tool.ruff]
target-version = "py311"

Expand Down

0 comments on commit ad8ad9e

Please sign in to comment.