github-clubhouse
v0.5.0
Published
import GitHub issues as stories in Clubhouse
Downloads
5
Readme
github-clubhouse
Import GitHub issues as stories in Clubhouse.
This module functions both as a library as well as a command-line tool.
Getting Started
Install the module in your project, or globally:
$ npm install --save github-clubhouse $ # ... OR ... $ npm install -g github-clubhouse
Using the Command-line Interface (CLI)
Learn about how to use the CLI:
$ gh2ch --help Usage: gh2ch GITHUB_ISSUE_URL CLUBHOUSE_PROJECT_NAME Options: -h, --help display this help message -s, --save-config save configuration into ~/.github-clubhouse --github-token=TOKEN your GitHub API token --clubhouse-token=TOKEN your Clubhouse API token $ ch2gh --help Usage: ch2gh CLUBHOUSE_STORY_NUMBER GITHUB_REPO_URL Options: -h, --help display this help message -s, --save-config save configuration into ~/.github-clubhouse --github-token=TOKEN your GitHub API token --clubhouse-token=TOKEN your Clubhouse API token
Import an issue from GitHub into Clubhouse:
$ gh2ch --save-config --github-token <GH-TOKEN> --clubhouse-token <CH-TOKEN> https://github.com/myorg/myrepo/issues/1 myproject
Export a story from Clubhouse to GitHub:
$ ch2ch --save-config --github-token <GH-TOKEN> --clubhouse-token <CH-TOKEN> 234 https://github.com/myorg/myrepo
Configuration
You can avoid having to type long API tokens by creating a ~/.github-clubhouse
file. The easiest way to create the file is to pass the -s
/ --save-config
option along with your tokens the first time you run the command. However, the file is in JSON
format, so you can edit it by hand or pre-create it yourself if you so choose. For example:
{
"githubToken": "aaaaaaaabbbbbbbbccccccccddddddddeeeeeeee",
"clubhouseToken": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee"
}
Usage
The library exports:
githubIssueToClubhouseStory
Returns: (Promise for Object): the story data as created
Parameters:
githubIssueURL
(String): the GitHub issue URLclubhouseProject
(String): the Clubhouse project name into which to import the issueoptions
(Object):githubToken
(String): the GitHub API tokenclubhouseToken
(String): the Clubhouse API token
clubhouseStoryToGithubIssue
Returns: (Promise for Object): the issue data as created
Parameters:
clubhouseStoryId
(Number): the Clubhouse story IDgithubRepoURL
(String): the repository URL on GitHub where the issue should be createdoptions
(Object):githubToken
(String): the GitHub API tokenclubhouseToken
(String): the Clubhouse API token
Contributing
Read the instructions for contributing.
Clone the repository.
Get your
NPM_AUTH_TOKEN
from https://npm.com andexport
it in your shell.Run the setup tasks:
$ npm install $ npm test
License
See the LICENSE file.