Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/dciborow/action-pylint
Github Action for Pylint
https://github.com/dciborow/action-pylint
Last synced: 3 months ago
JSON representation
Github Action for Pylint
- Host: GitHub
- URL: https://github.com/dciborow/action-pylint
- Owner: dciborow
- License: mit
- Created: 2021-07-23T02:22:21.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2024-09-03T13:16:13.000Z (5 months ago)
- Last Synced: 2024-10-18T07:16:59.443Z (4 months ago)
- Language: Shell
- Size: 57.6 KB
- Stars: 8
- Watchers: 2
- Forks: 15
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# action-pylint
[](https://github.com/dciborow/action-pylint/actions?query=workflow%3ATest)
[](https://github.com/dciborow/action-pylint/actions?query=workflow%3Areviewdog)
[](https://github.com/dciborow/action-pylint/actions?query=workflow%3Adepup)
[](https://github.com/dciborow/action-pylint/actions?query=workflow%3Arelease)
[](https://github.com/dciborow/action-pylint/releases)
[](https://github.com/haya14busa/action-bumpr)
This repo contains a action to run [pylint](https://pypi.org/project/pylint).
## Input
```yaml
inputs:
github_token:
description: "GITHUB_TOKEN"
required: true
default: "${{ github.token }}"
workdir:
description: "Working directory relative to the root directory."
required: false
default: "."
glob_pattern:
description: "Glob pattern of the files to lint"
required: false
default: "."
pylint_rc:
description: "Path to the .pylintrc configuration file. pylint automatically searches for it if not provided."
required: false
default: ""
pylint_args:
description: "Args provided to pylint."
required: false
default: ""
### Flags for reviewdog ###
tool_name:
description: "Tool name to use for reviewdog reporter."
required: false
default: "pylint"
level:
description: "Report level for reviewdog [info,warning,error]"
required: false
default: "error"
reporter:
description: "Reporter of reviewdog command [github-pr-check,github-pr-review]."
required: false
default: "github-pr-check"
filter_mode:
description: |
Filtering mode for the reviewdog command [added,diff_context,file,nofilter].
Default is added.
required: false
default: "added"
fail_on_error:
description: |
Exit code for reviewdog when errors are found [true,false]
Default is `false`.
required: false
default: "false"
reviewdog_flags:
description: "Additional reviewdog flags"
required: false
default: ""
```
## Usage
```yaml
name: reviewdog
on: [pull_request]
jobs:
pylint:
name: runner / pylint
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
- uses: dciborow/[email protected]
with:
github_token: ${{ secrets.github_token }}
# Change reviewdog reporter if you need [github-pr-check,github-check,github-pr-review].
reporter: github-pr-review
# Change reporter level if you need.
# GitHub Status Check won't become failure with warning.
level: warning
glob_pattern: "**/*.py"
```
## Development
### Release
#### [haya14busa/action-bumpr](https://github.com/haya14busa/action-bumpr)
You can bump version on merging Pull Requests with specific labels (bump:major,bump:minor,bump:patch).
Pushing tag manually by yourself also work.
#### [haya14busa/action-update-semver](https://github.com/haya14busa/action-update-semver)
This action updates major/minor release tags on a tag push. e.g. Update v1 and v1.2 tag when released v1.2.3.
ref: https://help.github.com/en/articles/about-actions#versioning-your-action
### Lint - reviewdog integration
This reviewdog action template itself is integrated with reviewdog to run lints
which is useful for Docker container based actions.
Supported linters:
- [reviewdog/action-shellcheck](https://github.com/reviewdog/action-shellcheck)
- [reviewdog/action-hadolint](https://github.com/reviewdog/action-hadolint)
- [reviewdog/action-misspell](https://github.com/reviewdog/action-misspell)
### Dependencies Update Automation
This repository uses [reviewdog/action-depup](https://github.com/reviewdog/action-depup) to update
reviewdog version.
[](https://github.com/reviewdog/action-template/pull/6)