Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

https://github.com/ankitvgupta/pycodestyle-action

A Github Action that runs pycodestyle and leaves a comment on your pull request with style errors.
https://github.com/ankitvgupta/pycodestyle-action

Last synced: about 1 month ago
JSON representation

A Github Action that runs pycodestyle and leaves a comment on your pull request with style errors.

Lists

README

        

# pycodestyle-action
A Github Action that runs pycodestyle and leaves a comment on your pull request.

## Example
Add the following to `.github/workflows/myworkflow.yml`.

Note that the PRECOMMAND_MESSAGE variable is optional. If you set it, it will print before
the code errors. For example, this is helpful if you want to print a message to refer the user
to any tools you have for managing style errors.

```
on: [pull_request]
name: Python Style Check
jobs:
pycodestyle:
name: pycodestyle
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@master
- name: pycodestyle
uses: ankitvgupta/pycodestyle-action@master
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
PRECOMMAND_MESSAGE: You have style errors. See them below.
```

### Acknowledgements
- https://github.com/jwr0/dockerfile-linter-action was a helpful resource in writing the Github API Calls.