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.

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.

By using the lizard-runner, engineers can keep track of the complexity of their code.

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!

The following code is the minimum code to make Lizard-Runner work. In the following cases, lizard is run with default settings.

name: Lizard Runner
on:
  push:

jobs:
  lizard:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v3
      - name: Lizard Runner
        uses: Uno-Takashi/Lizard-Runner@v3

lizard execution options can be passed as arguments. For example, the case for setting up CCN and execution paths is as follows.

      - name: Lizard Runner
        uses: Uno-Takashi/Lizard-Runner@v3
        with:
          path: "./src ./libs"
          CCN: "20"

See "Inputs" for a detailed description of all the arguments that can be set.

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.

For convenience, we have divided the arguments into several "classifications".

• Action Settings
  • Arguments to be used to set Action.
  • Arguments that do not exist in the original lizard.
• Wrapped Arguments
  • Wrapped arguments that exist in the original lizard.
  • For example, arguments that had to be specified individually in the original lizard can be passed together as a space-separated list.
  • e.g) language: "python cpp" → lizard --language python --language cpp
• Original Arguments
  • Arguments passed directly to lizard.
• Flag Arguments
  • Flag Argument." false" or "true" is passed. if "true" the flag is enabled.

The following is a summary of the arguments that can be specified. Details on the meaning of the arguments and the values to be given are provided in the wiki.

The paths to the two files are output. The following outputs can be accessed via ${{ steps..outputs }} from this action

If the outputs is referenced in a later Action, it will look like this

      - name: Lizard Runner
        uses: Uno-Takashi/Lizard-Runner@v3
        id: lizard
        with:
            input_file: "lizard_output.xml"
      - name: Get result_output_file
        run: echo -e "${{ steps.lizard.outputs.result_output_path }}"
      - name: Get cli_output_file
        run: echo -e "${{ steps.lizard.outputs.cli_output_path }}"
      - name: Archive lizard log
        uses: actions/upload-artifact@v2
        with:
          name: "lizard_cli_output"
          path: "${{ steps.lizard.outputs.cli_output_path }}"

Lizard Runner · Actions · GitHub Marketplace

Develop according to GitHub flow

If you have any questions, feel free to ask in the Q&A