Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Feature Request: Allow PEP8Speaks to be run as a CI job for private/forks #169

Open
OrkoHunter opened this issue May 6, 2020 · 1 comment

Comments

@OrkoHunter
Copy link
Collaborator

PEP8Speaks needs to be hosted on a server to be run. A GitHub webhook sends payloads to the server via "GitHub app" and the server does all the magic. For users who want to run PEP8Speaks on a private repository, it is recommended to deploy a fork.

There can be an even easier distribution possible for PEP8Speaks. This is to run it on the repository's CI as a lint job. If the user has setup Travis/CircleCI/etc. on their repository (for building and testing their PRs), they should be able to add a job for PEP8Speaks.

# (CircleCI example)
- run:
  - name: Install and run PEP8Speaks # https://github.com/OrkoHunter/pep8speaks
  - command: |
    pip install https://github.com/OrkoHunter/pep8speaks
    pep8speaks --gh_token=${GITHUB_TOKEN} --pr_url=${CIRCLE_PULL_REQUEST} --<extra_config_key=value>

PEP8Speaks needs to be converted into a Python package which generates a CLI pep8speaks. The CLI takes few parameters like GitHub token and Pull Request information, and it does exactly what PEP8Speaks should do (Comment on the PR by following .pep8speaks.yml).

@kronicka
Copy link

Was just browsing to see if I could set up a GitHub Actions workflow for pep8speaks.
Would be awesome if pep8speaks could be run as a CI job. Really looking forward to this feature.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants