hubot-board

A lightweight kanban-ish chat bot using github issues

Usage no npm install needed!

<script type="module">
  import hubotBoard from 'https://cdn.skypack.dev/hubot-board';
</script>

README

hubot-board Build Status

A lightweight kanban-ish chat bot for working with github issues

See src/board.js for full documentation.

Installation

In hubot project repo, run:

npm install hubot-board --save

This also requires hubot-github-identity >= 0.10.0. To add that to your project, use:

npm install --save hubot-github-identity@0.10.0

Then add hubot-board & hubot-github-identity to your external-scripts.json:

[
  "hubot-github-identity",
  "hubot-board"
]

Registering your github account with hubot

Step 1: Create a token to access your github info as yourself

curl -i https://api.github.com/authorizations -d '{"note":"token for slackbot","scopes":["repo"]}' -u “yourusername"

Step 2: Register your username and token

  • locally at http://localhost:8080/github/identity
  • production https://HUBOT_HOSTNAME/github/identity

Step 3: Tell hubot who you are

  • in a channel hubot I am eddywashere
  • direct message to hubot I am eddywashere

Chat commands

  • !board user/repo - shows default board (isssues labeled: ready, working, done)
  • **!board user/repo !new - <body> - creates a new issue</li> <li><b>!board user/repo !(backlog|ready|working|done)</b> - shows all backlog items</li> <li><b>!board user/repo !mine</b> - shows all issues assigned to you</li> <li><b>!board user/repo milestone:version</b> - shows board for the given milestone (ex: mile-stone-name:part-two)</li> <li>**!board user/repo milestone:version !new <title> - <body> - creates a new issue for a milestone</li> <li><b>!board user/repo milestone:version !(backlog|ready|working|done)</b> - show backlog issues for the given milestone</li> <li><b>!board user/repo milestone:version !mine</b> - show issues assigned to you for the given milestone</li> </ul> <h2><a id="todo" class="anchor" aria-hidden="true" href="#todo"></a>TODO</h2> <ul> <li>brainstorm ideas for sorting issues by priority</li> <li>add in commands as needed</li> </ul> </div></article> <aside><h2 class="svelte-1u3txz5">Details</h2> <dl class="details f-d1 svelte-1u3txz5"><div class="svelte-1u3txz5"><dt class="svelte-1u3txz5">Downloads (weekly)</dt> <dd class="f-mono f-h1"><div class="container svelte-a3j687"><div class="dot svelte-a3j687"></div> <div class="dot svelte-a3j687"></div> <div class="dot svelte-a3j687"></div> </div></dd> </div><div class="svelte-1u3txz5"><dt class="svelte-1u3txz5">Updated</dt> <dd><time class="" datetime="2015-07-05T22:36:36.139Z">July 5, 2015</time></dd> </div><div class="svelte-1u3txz5"><dt class="svelte-1u3txz5">Created</dt> <dd><time class="" datetime="2015-07-05T03:37:58.342Z">July 5, 2015</time></dd> </div><div class="svelte-1u3txz5"><div class="wrapper svelte-qjxoui"><dt class="header svelte-qjxoui"><span class="title svelte-qjxoui">Package score <a class="ml1 f-w400" href="https://docs.skypack.dev/package-authors/package-checks" target="_blank">learn more</a></span> <span class="f-u1"> <div class="container svelte-a3j687"><div class="dot svelte-a3j687"></div> <div class="dot svelte-a3j687"></div> <div class="dot svelte-a3j687"></div> </div></span></dt> <dd class="pt1"><ul class="checks"><li class="checks-check svelte-qjxoui"><span class="status__loading svelte-qjxoui" aria-label="loading"></span>Package Security </li><li class="checks-check svelte-qjxoui"><span class="status__warn svelte-qjxoui" aria-label="not added yet"></span> ES Module Entrypoint <a class="action svelte-qjxoui" href="https://docs.skypack.dev/package-authors/package-checks#esm" target="_blank" rel="noopener noreferrer">Info</a> </li><li class="checks-check svelte-qjxoui"><span class="status__warn svelte-qjxoui" aria-label="not added yet"></span> Export Map <a class="action svelte-qjxoui" href="https://docs.skypack.dev/package-authors/package-checks#export-map" target="_blank" rel="noopener noreferrer">Info</a> </li><li class="checks-check svelte-qjxoui"><svg class="status__check svelte-qjxoui" fill="none" xmlns="http://www.w3.org/2000/svg" viewBox="0 0 13 9"><title>added Keywords
  • added License
  • added README
  • added Repository URL
  • TypeScript Types Info
License
MIT
Dependencies
3
Links
Keywords
Collaborators