/PRVision

Primary LanguageJavaScriptISC LicenseISC

PRemix

A GitHub App built with Probot that shows you the output of your code in your PR itself!

Setup

# Install dependencies
npm install

# Run the bot
npm start

Docker

# 1. Build container
docker build -t PRemix .

# 2. Start container
docker run -e APP_ID=<app-id> -e PRIVATE_KEY=<pem-value> PRemix

Screen Recording

https://drive.google.com/file/d/1rsFNDi8VRq5DA8tNeVuVCvxCkCcRNyNq/view?usp=sharing

How to use?

To run a file:

  • Create your code file and open a Pull Request.
  • Since the bot uses the exact file location, you can place your file anywhere with any name.
  • The bot looks up for the following command to run your file:
    • /execute path/to/file for example: /execute code/test.py
  • You can pass on this command in your commit messages while creating the PR or as a comment afterwards.
  • Words following or preceeding the cmd above will be ignored.
  • Compile timeout: 10 seconds
  • Run timeout: 3 seconds
  • A list of supported languages along with there runtime versions can be found here.

Permission(s) required:

permission event it listens to
contents: read push
issues: write issue_comment
pull_requests: write pull_request
metadata: read (mandatory)

Contributing

If you have suggestions for how PRemix could be improved, or want to report a bug, open an issue! We'd love all and any contributions.

For more, check out the Contributing Guide.

License

ISC © 2023 Prince Singh