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: 6 days ago
JSON representation

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

• Host: GitHub
• URL: https://github.com/ankitvgupta/pycodestyle-action
• Owner: ankitvgupta
• License: mit
• Created: 2019-09-13T00:13:41.000Z (about 5 years ago)
• Default Branch: master
• Last Pushed: 2019-09-13T18:45:18.000Z (about 5 years ago)
• Last Synced: 2024-08-02T07:13:48.227Z (3 months ago)
• Language: Shell
• Homepage:
• Size: 19.5 KB
• Stars: 8
• Watchers: 3
• Forks: 4
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-actions - PyCodeStyle Action - A GitHub Action that leaves a comment on your PR with pycodestyle (autopep8) feedback
• fucking-awesome-actions - PyCodeStyle Action - A GitHub Action that leaves a comment on your PR with pycodestyle (autopep8) feedback
• awesome-workflows - PyCodeStyle Action - A GitHub Action that leaves a comment on your PR with pycodestyle (autopep8) feedback

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.