🤖💬 Rupert-the-Bot

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:

• 🎉 Gives a warm welcome when a new issue or pull request is opened. Rupert loves to make contributors feel heard and appreciated!
• 👋 Sends a friendly farewell message when an issue or pull request is closed. Rupert is always there to acknowledge the hard work that goes into resolving issues.

What is it? 🤓

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."

🚀 Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.

🛠️ Setup

1. Install dependencies 📦

   npm install
   

2. Run the bot 🏃‍♀️

   npm start
   

3. Lint the code 🧹

   npm run lint
   

4. Run the tests 🧪

   npm test
   

5. Watch for changes and rerun tests 👀

   npm run watch
   

6. Start the app in debug mode 🐞

   npm run debug
   

7. Clean up temporary files and build artifacts 🧽

   npm run clean
   

8. Format the code 🖋️

   npm run format
   

9. 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.

🐳 Docker

You can also run Rupert-the-Bot in a Docker container.

1. Build the container

   docker build -t rupert-the-bot .
   

2. Start the container

   docker run -e APP_ID=<app-id> -e PRIVATE_KEY=<pem-value> rupert-the-bot
   

🛠️ CI/CD Workflows

Rupert-the-Bot uses GitHub Actions:

🚧 CI Workflow

• 🔄 Runs on pushes/pull requests
• ⚙️ Setup, 📦 install, 🖋️ format, 🧹 lint, 🧪 test

🚀 Deployment

• 📥 Deploys to AWS Lambda on push
• 📦 Package and deploy with AWS SAM (Serverless Application Model, a framework for building and deploying serverless applications on AWS)

🔒 Dependency & Security

• ⏰ Monthly updates and scans
• 🛡️ Vulnerability scan with Debricked
• 🔁 Revert on test or scan failures

🤝 Contributing

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.

📜 License

ISC © 2024 Jagoda Cubrilo