diff --git a/README.md b/README.md index 7c939d2..63a0c4c 100644 --- a/README.md +++ b/README.md @@ -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). diff --git a/action.yml b/action.yml index fdf08d5..3c56a65 100644 --- a/action.yml +++ b/action.yml @@ -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: diff --git a/action/main.py b/action/main.py index e91719e..66a2afa 100644 --- a/action/main.py +++ b/action/main.py @@ -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]) diff --git a/pyproject.toml b/pyproject.toml index d9fa42a..12ee549 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -1,5 +1,3 @@ - - [tool.ruff] target-version = "py311"