๐ A GitHub Probot app (named Rupert ๐ค) that welcomes users when they open an issue ๐ or a pull request ๐. Rupert lives in AWS โ๏ธ and is always ready to assist!
ISC License
Rupert-the-Bot is a GitHub App built with Probot. It's designed to make your development workflow more engaging and efficient.
Rupert loves to interact with contributors! Here's what Rupert can do:
As explained by Jason Etcovitch in his post:
"At its core, Probot uses Express to run a Node.js HTTP server. When an event happens on GitHub that your Probot app is configured to care about, GitHub sends HTTP POST requests (webhooks) to a special 'webhook endpoint,' containing information in a JSON payload about what event was triggered."
These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.
Install dependencies ๐ฆ
npm install
Run the bot ๐โโ๏ธ
npm start
Lint the code ๐งน
npm run lint
Run the tests ๐งช
npm test
Watch for changes and rerun tests ๐
npm run watch
Start the app in debug mode ๐
npm run debug
Clean up temporary files and build artifacts ๐งฝ
npm run clean
Format the code ๐๏ธ
npm run format
Run tasks before each commit ๐ง
npm run precommit
Note: We've set up a pre-commit hook with Husky ๐ถ, so this script will automatically run before each commit.
You can also run Rupert-the-Bot in a Docker container.
Build the container
docker build -t rupert-the-bot .
Start the container
docker run -e APP_ID=<app-id> -e PRIVATE_KEY=<pem-value> rupert-the-bot
Rupert-the-Bot uses GitHub Actions:
We love contributions! If you have suggestions for how Rupert-the-Bot could be improved, or want to report a bug, open an issue! We'd appreciate any contributions.
Please note that this project is governed by a Code of Conduct. By participating in this project, you agree to abide by its terms.
For more, check out the Contributing Guide
To contribute, you can fork this repository.
ISC ยฉ 2024 Jagoda Cubrilo