astral-sh / ruff

An extremely fast Python linter and code formatter, written in Rust.
https://docs.astral.sh/ruff
MIT License
32.1k stars 1.07k forks source link

Github action documentation refers to 'options' instead of 'args' #10246

Closed elliot-100 closed 7 months ago

elliot-100 commented 7 months ago

https://docs.astral.sh/ruff/integrations/#github-actions says:

ruff-action accepts optional configuration parameters via with:, including:

  • version: The Ruff version to install (default: latest).
  • options: The command-line arguments to pass to Ruff (default: "check").
  • src: The source paths to pass to Ruff (default: ".").

I think 'options' here should be 'args' to match the example code:

- uses: chartboost/ruff-action@v1
  with:
    src: "./src"
    version: 0.0.259
    args: --select B

as using options gives:

Warning: Unexpected input(s) 'options', valid inputs are ['args', 'src', 'version']

MichaReiser commented 7 months ago

Thanks; you're right. This should be args, according to the GitHub action's documentation. Would you be interested PRing a fix for the documentation?

elliot-100 commented 7 months ago

Thank you!