Skip to content

Latest commit

 

History

History
39 lines (28 loc) · 1.7 KB

README.md

File metadata and controls

39 lines (28 loc) · 1.7 KB

probot-radar

a GitHub Integration built with probot that creates status update issues (radars).

A bot that collates issues with labels and presents them in as a tracking issue in another repo (i.e what's on my radar like feature) probot-radar

Configuration

Adding a .github/radar.yml will override these defaults

#Number of days before closing a radar issue (not implemented yet!)
days: 7

#Issues with labels to collate
labels: ['blocked','ready-for-review', 'tracking']

#A separate repo to create the radar issues along with radar specfic labels
radar:
    repo: 'radar-repo'
    labels: ['radar']

Setup

# Install dependencies
npm install

# Run the bot
npm run

For more information, see the documentation for probot.

Deploying to Heroku

  1. Deploy - Click this button and pick an App Name that Heroku is happy with. Before you can complete this, you'll need config variables from the next step.

  2. In another tab, create an integration on GitHub, using https://[yourappname].herokuapp.com/ (replacing [yourappname] with the name from step 1) as the Homepage URL, Callback URL, and Webhook URL. The permissions and events that your bot needs access to will depend on what you use it for. Read more about creating an integration.

  3. After creating your GitHub integration, go back to the Heroku tab and fill in the configuration variables with the values for the GitHub Integration