Important: This documentation covers Yarn 1 (Classic).
For Yarn 2+ docs and migration guide, see yarnpkg.com.

Package detail

codeship

John-Lin24MIT0.1.1

An API wrapper of Codeship

codeship, cd, ci

readme

codeship-api

npm version Build Status

An better API wrapper for Codeship.

Codeship API Docs

Install

With npm do:

npm install codeship

How do I get a API key?

After sign up Codeship. You can get your API key on your account page.

Example usage

'use strict';
let Codeship = require('codeship');
let codeship = new Codeship('APIKEY');

codeship.listProjects((err, results) => {
  if (err) throw err;
  console.log(results);
});

codeship.getProject('111139', (err, result) => {
  if (err) throw err;
  console.log(result);
});

codeship.getProjectBuildData('111139', (err, result) => {
  if (err) throw err;
  console.log(result);
});

APIs

codeship.listProjects(cb)

Return an array include all projects on codeship.

codeship.getProject(projectId, cb)

Return a single project projectId is required.

codeship.getProjectBuildData(projectId, cb)

Return build data in a single project projectId is required.

License

MIT © Che-Wei Lin