https://github.com/skhomuti/pylint-actions

Pylint plugin to support GitHub Actions annotations
https://github.com/skhomuti/pylint-actions

actions github-actions linter pylint pylint-plugin

Last synced: 6 days ago
JSON representation

Pylint plugin to support GitHub Actions annotations

• Host: GitHub
• URL: https://github.com/skhomuti/pylint-actions
• Owner: skhomuti
• License: mit
• Created: 2023-03-12T12:43:21.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2024-06-11T08:09:10.000Z (5 months ago)
• Last Synced: 2024-10-24T06:00:09.935Z (15 days ago)
• Topics: actions, github-actions, linter, pylint, pylint-plugin
• Language: Python
• Homepage:
• Size: 49.8 KB
• Stars: 7
• Watchers: 1
• Forks: 2
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
![](https://img.shields.io/pypi/v/pylint-actions)

![](https://img.shields.io/pypi/dm/pylint-actions)

![](https://img.shields.io/pypi/pyversions/pylint-actions)

# Pylint plugin for GitHub Actions annotations

This is a plugin for [Pylint](https://www.pylint.org/) that allows it to output annotations 

in the format that GitHub Actions understands. 

See annotations from [examples](https://github.com/skhomuti/pylint-actions/actions/workflows/example.yml) workflows.

Also these annotations will be displayed in your pull requests changes

# Installation

So simple:

```bash

pip install pylint-actions

```

# Usage

Add the following to your `pyproject.toml` file:

```toml

[tool.pylint.main]

load-plugins = "pylint_actions"

```

Or load the plugin with any available pylint configuration variants except command line arguments.

Next, run pylint with the `--output-format=actions` option, or shorted `-f actions`.

In your GitHub Actions workflow, use it like this:

```yaml

- name: Run pylint

  run: poetry run pylint -f actions src

```