Skip to content
You're viewing an older version of this GitHub Action. Do you want to see the latest version instead?
wind

GitHub Action

Lizard Runner

v1

Lizard Runner

wind

Lizard Runner

GitHub action to lint your python code with lizard

Installation

Copy and paste the following snippet into your .yml file.

              

- name: Lizard Runner

uses: Uno-Takashi/Lizard-Runner@v1

Learn more about this action in Uno-Takashi/Lizard-Runner

Choose a version

Lizard Runner

pyt License: MIT Python Docker

Lizard Runner is a third-party OSS Github Action for easy execution of lizard.

  • Rapid Container
    • The Lizard Runner employs a lightweight container to achieve build times that are competitive with the combination of actions/setup-python and pip. In most cases, preparation to begin analysis takes less than 30 seconds.
  • Easy-to-use variable specification
    • Wrapping command line arguments allows for more intuitive execution.
  • Can be embedded in CI
    • The complexity of the code can always be measured. This prevents the inclusion of overly complex codes.

๐Ÿ—ž๏ธ Introduction

As code becomes more complex, it becomes less maintainable.

Often, code that was easy to modify in the early stages of a product's life can become so complex and huge before long that it becomes unmaintainable.

๐Ÿ› ๏ธ Why We Built It

In general, CI allows engineers to gain psychological security by keeping test code running. That is, they continue to be assured that the code they add will not have a fatal negative impact on the service.

We wanted to incorporate and visualize code complexity within the CI framework. By doing this, we wanted to make it more psychologically safe for engineers to merge code, ensuring that the code they wrote would not become a bottleneck in the refurbishment.

For this reason, we have created a Github action that makes it easy to run lizard!

๐Ÿ“š Usage

๐Ÿ“ฅ Inputs

Most of the input is the same as in the lizard, but some original input is required for lizard-runner. Some arguments are also wrapped for convenience.

๐Ÿ“ค Outputs

๐Ÿ›’ How to Get

GitHub Marcket Place