https://github.com/oppia/oppiabot
Helper bot for the Oppia code repository dev workflow.
https://github.com/oppia/oppiabot
Last synced: 4 months ago
JSON representation
Helper bot for the Oppia code repository dev workflow.
- Host: GitHub
- URL: https://github.com/oppia/oppiabot
- Owner: oppia
- License: apache-2.0
- Created: 2018-04-26T21:35:02.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2025-09-02T13:50:37.000Z (4 months ago)
- Last Synced: 2025-09-15T12:40:40.107Z (4 months ago)
- Language: JavaScript
- Homepage:
- Size: 3.24 MB
- Stars: 20
- Watchers: 4
- Forks: 71
- Open Issues: 14
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Security: SECURITY.md
Awesome Lists containing this project
README
# Oppiabot
Oppiabot is a GitHub app built with [probot](https://github.com/probot/probot). It acts as a helper for the Oppia code repository to maintain the development workflow. It is hosted on [Heroku](https://www.heroku.com/).
## Getting started
Please refer to the following instructions to setup Oppiabot for the first time on your machine:
1. Create a new folder called `opensource/` within your home folder (or use one that you already have). Navigate to it (`cd opensource`), then [fork and clone](https://help.github.com/articles/fork-a-repo/) the Oppiabot repo. This will create a new folder named `opensource/oppiabot`. Navigate to `opensource/oppiabot/`.
2. Install [Node.Js](https://nodejs.org/) and [NPM](https://www.npmjs.com/) on your machine using the following commands:
First check if you already have Node.js and NPM using:
```bash
node -v
npm -v
```
If these commands show some versions, then you can jump to Point No. 3, else proceed in this point:
#### Using Ubuntu
```bash
curl -sL https://deb.nodesource.com/setup_lts.x | sudo -E bash -
sudo apt install -y nodejs
```
#### Using MacOS
```bash
sudo brew install node
```
#### Using Windows
Use [WSL with Ubuntu](https://learn.microsoft.com/en-us/windows/wsl/install) and then follow the Ubuntu instructions.
3. Setup probot and other dependencies by running the following command:
```bash
npm install
```
4. The Oppiabot uses environment variables. These are configured in the server settings. To deploy the bot locally, create a `.env` file and copy the contents of `.env.example` to it. You will need to adjust these variables accordingly following the instructions in the subsequent steps. Run following command to copy `.env.example` to `.env`
If you have Linux terminal type:
```bash
cp .env.example .env
```
5. Go to [smee.io](https://smee.io/) and click **Start a new channel**. Set `WEBHOOK_PROXY_URL` in `.env` to the URL that you are redirected to.
6. [Create a new GitHub App](https://github.com/settings/apps/new) with:
* **GitHub App name**: Use something like "My Oppiabot testing App"
* **Homepage URL**: Use any random URL
* **Webhook URL**: Use your `WEBHOOK_PROXY_URL` from the previous step.
* **Webhook Secret**: `development`
* **Permissions & events** The following permissions and events must be subscribed. If, for example, you only enable issue events, you will not be able to listen on pull request webhooks with the bot.
7. Download the private key. It will be a `.pem` file. Move it to the root directory of the project. As long as it's in the root directory, it will be automatically detected regardless of the filename.
Make sure you remove
> PRIVATE_KEY=example_private_key
from .env file, Otherwise app will not work locally.
8. Edit `.env` and set `APP_ID` to the ID of the app you just created and also `WEBHOOK_SECRET` to `development`. The App ID can be found in your app settings page here.
## Installing the bot on a repository
1. Identify a target repository and install the bot by clicking the Install button on the settings page of your app, e.g., **`https://github.com/settings/apps/my-oppiabot-testing-app/installations`**
2. Update the **`.env` file**:
- Add your GitHub account name to `WHITELISTED_ACCOUNTS`.
3. Add the repository name in the **`constants.js` file**:
- Open the **`constants.js`** file in the bot's source code.
- Navigate to the `checksWhitelist` object.
- Add a new entry with your repository name (in lowercase) as the key. The value should define the checks and events specific to your repository.
**Example:**
If your repository name is `my-repo`, the `checksWhitelist` object will look like this:
```javascript
const checksWhitelist = {
// Existing entries...
'my-repo': {
[openEvent]: [claCheck],
[reopenEvent]: [],
[openEventGithubActions]: [claCheckGithubAction],
[reopenEventGithubActions]: [claCheckGithubAction],
[synchronizeEvent]: [mergeConflictCheck],
[closeEvent]: [allMergeConflictCheck],
[editEvent]: [],
[issuesLabelEvent]: [],
[issuesAssignedEvent]: [],
[pushEvent]: [],
[pullRequestReviewEvent]: [pullRequestReviewCheck],
[issueCommentCreatedEvent]: [respondToReviewCheck],
},
};
```
4. Save the changes to **`constants.js`**.
## Running the bot locally
You are now ready to run the bot on your local machine. Run `npm run dev` to start the server.
The `dev` script will start the bot using [nodemon](https://github.com/remy/nodemon#nodemon), which will watch for any files changes in your local development environment and automatically restart the server.
### Other available scripts
`npm start` to start the bot without watching files.
## Debugging
Always run `npm install` and restart the server if `package.json` has changed.
To turn on verbose logging, start server by running: `LOG_LEVEL=trace npm start`.
Run `npm test` to run all the tests locally.
## Support
If you have any feature requests or bug reports, please log them on our [issue tracker](https://github.com/oppia/oppiabot/issues/new?title=Describe%20your%20feature%20request%20or%20bug%20report%20succinctly&body=If%20you%27d%20like%20to%20propose%20a%20feature,%20describe%20what%20you%27d%20like%20to%20see.%20Mockups%20would%20be%20great!%0A%0AIf%20you%27re%20reporting%20a%20bug,%20please%20be%20sure%20to%20include%20the%20expected%20behaviour,%20the%20observed%20behaviour,%20and%20steps%20to%20reproduce%20the%20problem.%20Console%20copy-pastes%20and%20any%20background%20on%20the%20environment%20would%20also%20be%20helpful.%0A%0AIf%20the%20issue%20you%27re%20facing%20is%20probot-specific,%20it%20should%20be%20logged%20to%20the%20probot%20repository.%0A%0AThanks!).
Please report security issues directly to admin@oppia.org.
## License
The Oppiabot code is released under the [Apache v2 license](https://github.com/oppia/oppiabot/blob/master/LICENSE).