README

carpenterd-api-client

The carpenterd-api-client is an API client for the carpenterd build service.

Install

Install carpenterd-api-client from the npm registry:

npm install --save carpenterd-api-client

API

In all examples we assume that you've already initialized the client as followed:

'use strict';

var Carpenter = require('carpenterd-api-client');

var carpenter = new Carpenter('url-to-the-service');

As you can see in the example above, the Carpenter constructor requires one argument:

The URL of the carpenter API where we should send the requests to.

build

Trigger a new build on carpenter service. The data provided should have the same structure and signature as npm publish posted JSON.

carpenter.build({ data: {
  "name": "tester",               // name of the package
  "dist-tags": {
    "latest": "1.0.0"
  },
  "versions": {
    "1.0.0": {
      "name": "tester",
      "version": "1.0.0"
      ...
    }
  },
  "_attachment": ""               // base64 encoded binary blob
}}, function () {

});

cancel

Cancel a build on carpenter service.

carpenter.cancel({
  "pkg": "tester",                  // name of the package
  "version": "1.0.0",               // valid semver
  "env": "prod"                     // optional environment parameter
}}, function () {

});

Tests

npm test

License

MIT

Usage no npm install needed!