Skip to content

actions_python_ruff

Actions
Github action for running python linting with ruff
v1.0.2
Latest
Star (2)

actions_python_ruff

A Github action for python linting with ruff.


How to use

In your .github/workflows directory, create a yaml file (such as main.yaml). Add a job for each desired workflow with the uses keyword. Use the with keyword to pass any desired variables.

Examples:

on: [push]

jobs:
  ruff:
    runs-on: ubuntu-latest
    name: "ruff"
    steps:
      - uses: davidslusser/[email protected]

on: [push]

jobs:
  ruff:
    runs-on: ubuntu-latest
    name: "ruff"
    steps:
      - uses: davidslusser/[email protected]
        with:
          src: "src"
          options: "--cov=src"
          pip_install_command: "pip install -e .[dev]"
          python_version: "3.9"

Inputs

  • src: source directory of code to check (defaults to ".")
  • options: optional flags/parameters used in ruff command
  • pip_install_command: pip install command (defaults to "pip install ruff")
  • python_version: version of python to run workflow with (defaults to "3.x")

References

actions_python_ruff is not certified by GitHub. It is provided by a third-party and is governed by separate terms of service, privacy policy, and support documentation.

About

Github action for running python linting with ruff
v1.0.2
Latest

actions_python_ruff is not certified by GitHub. It is provided by a third-party and is governed by separate terms of service, privacy policy, and support documentation.