Skip to content

Latest commit

 

History

History
52 lines (35 loc) · 1.46 KB

README.md

File metadata and controls

52 lines (35 loc) · 1.46 KB
Raw

hubot-octocat

A hubot script that provides Github repository information

Commands

  • hubot (show) prs - Displays a list of open pull requests for all repositories
  • hubot (show) prs (for) <repo_name> - Displays a list of open pull requests for a particular repository

Installation

In hubot project repo, run:

npm install hubot-octocat --save

Then add hubot-octocat to your external-scripts.json:

[
  "hubot-octocat"
]

Configuration

The plugin depends on environment variables beginning with HUBOT_OCTOCAT_. The following configurations are available:

  • HUBOT_OCTOCAT_OAUTH_TOKEN - (Required) A GitHub OAuth token
  • HUBOT_OCTOCAT_USER - A GitHub username
  • HUBOT_OCTOCAT_TEAM_ID - A GitHub Team ID, takes precedence over HUBOT_OCTOCAT_USER.
  • HUBOT_OCTOCAT_ORG - A GitHub organization name, takes precedence over HUBOT_OCTOCAT_TEAM_ID

A username, team ID, or organization name must be specified.

Sample Interaction

user> hubot show prs
hubot> There are 3 open pull requests.

org/awesome-project
┬──────────────────
├─ #24 Fix all the things » unassigned » updated 45 seconds ago
└─ #27 Important change » someone » updated 2 days ago

 org/another-project
┬───────────────────
└─ #12 Fix all things » someone » updated 5 days ago

NPM Module

https://www.npmjs.com/package/hubot-octocat