GitHub Polls Bot

A GitHub App built with Probot that automatically creates gh-polls in GitHub issues.

Usage

1. Configure the GitHub App: github.com/apps/polls
2. Add command to issue:

/polls Option1 'Option 2' "Option 3"

# Automatically replace with the following markdown =>
[![](https://api.gh-polls.com/poll/01BY7ECS60GG8F9AR1VMR8745S/Option1)](https://api.gh-polls.com/poll/01BY7ECS60GG8F9AR1VMR8745S/Option1/vote)
[![](https://api.gh-polls.com/poll/01BY7ECS60GG8F9AR1VMR8745S/Option%202)](https://api.gh-polls.com/poll/01BY7ECS60GG8F9AR1VMR8745S/Option%202/vote)
[![](https://api.gh-polls.com/poll/01BY7ECS60GG8F9AR1VMR8745S/Option%203)](https://api.gh-polls.com/poll/01BY7ECS60GG8F9AR1VMR8745S/Option%203/vote)

Screenshot
Demo

Developer Guide

Environments

• Create a .env file from .env.example.
• Download the private-key.pem from GitHub and move it to your project’s directory.

Note: Please follow the Developing an App section of Probot documents.

Requirements

• node >= 9.0.0
• yarn >= 1.3.2

$ git clone https://github.com/evenchange4/gh-polls-bot
$ yarn install --pure-lockfile

$ yarn run dev # dev server
$ yarn start   # prod server

Test

$ yarn run format
$ yarn run eslint
$ yarn run test:watch
$ yarn run flow
$ yarn run flow-coverage

Deploy to Now.sh

Any git commits push to master branch.

$ npm version patch
$ yarn run changelog

Note: PRIVATE_KEY pem workaround: first-timers-bot #89

Technology Stacks

• Create-Probot-App
• Travis - CI
• Zeit Now.sh

Inspiration

• https://github.com/probot/commands
• https://github.com/srph/gh-polls-web

Misc

• Redirect to github.com for private repos. [apex/gh-polls#3]
• PEM format doesn't play nicely with now.sh secrets/env vars. [probot/friction#17]
• Links related to GH polls:
  • Web App – GH polls web app
  • apex/gh-polls – Polls for user feedback in GitHub issues gh-polls.com
  • bukinoshita/gh-polls – node module to create gh-polls

CONTRIBUTING

• ⇄ Pull requests and ★ Stars are always welcome.
• For bugs and feature requests, please create an issue.
• Pull requests must be accompanied by passing automated tests ($ yarn run test).

CHANGELOG

LICENSE

MIT: http://michaelhsu.mit-license.org