node-zenhub

A Node.js wrapper for the ZenHub API

Install

node-zenhub is available on npm and as such, can be installed through npm with ease.

To install node-zenhub and add it to your package.json file, use the following command:

$ npm install --save node-zenhub

Documentation

The official ZenHub documentation

Usage

In order to use node-zenhub you will need to generate an API token on the ZenHub website. Once you have this, add the library to your project with the following command:

$ npm install --save node-zenhub

Once installed you need to instantiate a new copy of node-zenhub in your application, like so:

var callback = function (error, data) {
    console.log(error);
    console.log(data);
}

var ZenHub = require('node-zenhub'),
    api = new ZenHub('[token]', [zenhub_api_url]);

api.boards.getBoard('[repoId]', callback);

Note: replace [token] with your token.

Note: [zenhub_api_url] is optional, you can use it with enterprise versions with custom URL

Available methods

Issues

• getIssue
• getIssueEvents
• setEstimateForIssue
• moveIssueBetweenPipelines

Boards

• getBoard

Epics

• getEpics
• getEpicData
• convertIssueToEpic
• convertEpicToIssue
• addOrRemoveToEpic

Milestones

• getMilestoneStartDate
• setMilestoneStartDate

Release Reports

• createReleaseReport
• getReleaseReport
• getReleaseReportsForRepository

Running the Tests

The tests are based on the mocha module, which may be installed via npm. To run the tests make sure that the npm dependencies are installed by running npm install from the project directory.

create file test/config.json from test/config.sample.json with your values

{
    "token": "xxxxxxxxxx",
    "repoId": "xxxxx",
    "issueId": 1,
    "milestoneNumber": 1,
    "releaseId": "59d3cd520a430a6344fd3bdb",
    "zenhubAPI": "https://zenhub.enterprise.com"
}

At the moment, test classes can only be run separately. This will e.g. run the Issues Api test:

npm test

Issues

Please raise an issue on GitHub with as much information as possible and the steps to replicate (if possible).

LICENSE

MIT license. See the LICENSE file for details.

---

Fork me on github

Created by @ilbonzo