https://github.com/reasonsoftware/action-pylint

Pylint GitHub Action
https://github.com/reasonsoftware/action-pylint

action cd ci github-actions linter pylint python python3

Last synced: 2 months ago
JSON representation

Pylint GitHub Action

• Host: GitHub
• URL: https://github.com/reasonsoftware/action-pylint
• Owner: ReasonSoftware
• License: apache-2.0
• Created: 2023-12-05T14:32:59.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2025-01-02T10:47:38.000Z (4 months ago)
• Last Synced: 2025-01-02T11:30:14.232Z (4 months ago)
• Topics: action, cd, ci, github-actions, linter, pylint, python, python3
• Language: Shell
• Homepage: https://github.com/marketplace/actions/pylint-github-action
• Size: 33.2 KB
• Stars: 1
• Watchers: 7
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE.md
  • Codeowners: .github/CODEOWNERS

Awesome Lists containing this project

README

        
# Python Linter GitHub Action

[![CI](https://github.com/ReasonSoftware/action-pylint/actions/workflows/release.yml/badge.svg)](https://github.com/ReasonSoftware/action-pylint/actions/workflows/release.yml)

[![Release](https://img.shields.io/github/v/release/ReasonSoftware/action-pylint)](https://github.com/ReasonSoftware/action-pylint/releases/latest)

[![Python](https://img.shields.io/badge/python-3.12.8-greenyellow.svg)](https://www.python.org/downloads/release/python-3128/)

[![Pylint](https://img.shields.io/badge/pylint-3.3.3-blue.svg)](https://pypi.org/project/pylint/)

[![Debian](https://img.shields.io/badge/debian-12.8-purple.svg)](https://www.debian.org/releases/bookworm/)

[![Docker Pulls](https://img.shields.io/docker/pulls/reasonsoftware/action-pylint)](https://hub.docker.com/r/reasonsoftware/action-pylint)

[![License](https://img.shields.io/github/license/ReasonSoftware/action-pylint)](LICENSE.md)

## Overview

This **Pylint GitHub Action** runs pylint command and returns the score.  

Action fails if pylint score is less than 10.00/10.

```yaml

- name: Python linter

  id: pylint

  uses: docker://reasonsoftware/action-pylint:v2

```

## Inputs

|       _Input_       |                   _Description_                   |                _Default_                 | _Required_ |

|:-------------------:|:-------------------------------------------------:|:----------------------------------------:|:----------:|

|     `filepaths`     | A list of all paths to test. ("\*/\*.py", "src/") |                   "."                    |     no     |

|      `options`      |                   Extra options                   | "--recursive=y --rcfile=/pyproject.toml" |     no     |

| `requirements_file` |             requirements.txt filepath             |                    ""                    |     no     |

|    `init_script`    |   Environment preparation shell script filepath   |                    ""                    |     no     |

## Outputs

| _Output_ |    _Description_     | _Example_  |

|:--------:|:--------------------:|:----------:|

| `score`  | Pylint checked score | "10.00/10" |

## Annotations

Pylint failed

:red_circle: Pylint score

9.18/10

Pylint passed

:grey_exclamation: Pylint score

10.00/10

## License

[Apache-2.0](LICENSE.md) © 2023 [Reason Cybersecurity Ltd.](https://www.reasonsecurity.com/)