superset-github-bot

A Github bot to automatically label issues and PRs, built with Probot that A Probot app

Setup

# Install dependencies
npm install

# Start developing 
npm run dev

Current actions

• auto assigns organization as a label
  • orgs have to be whitelisted in src/config.js
  • affiliation to org has to be public, here's how to set this up
• can add a label with a comment that contains 🏷mylabel
• can remove a label with a comment that contains 🗑🏷mylabel

Resources

• Bot page: https://github.com/settings/apps/superset-github-bot
• Probot templates / examples: https://probot.github.io/apps/
• Issue labeller: https://github.com/riyadhalnur/issuelabeler

To develop / test

To avoid conflicting with the production bot, you'll need to create your own Github app following the Probot instructions. This creates both a brand new Probot using a template and a new Github app on your behalf using the "Register Github App" flow. This will generate a .env file that contains secrets. Moving this file over to the github-superset-bot will effectively bind your new app to the existing Probot. You'll then have to register your app against a repo of your choice to test things out. Once you run npm run dev, you should start seeing events firing in your bot.

Note: Be sure to create a private key, as described in the probot docs, otherwise Probot will silently ignore your app!!

Deploy

The bot lives on Heroku for now:

1. you'll need an Heroku account and ask the mailing list to get your account added here (only for committers)

2. Grab the Heroku CLI

   $ brew tap heroku/brew
   $ brew install heroku

3. Login to Heroku

   $ heroku login 

4. Add the Heroku remote

   $ git remote add heroku https://git.heroku.com/superset-github-bot.git 

5. To deploy -

   $ git push heroku master

• app page is here: https://dashboard.heroku.com/apps/superset-github-bot
• app is served here: https://superset-github-bot.herokuapp.com/probot
• Probot deploy docs