README
Sync
Installation
$ npm install travis-ci-sync
Usage
var sync = require( 'travis-ci-sync' );
sync( options, clbk )
Syncs a Travis CI account with Github.
var opts = {
'token': 'tkjorjk34ek3nj4!'
};
sync( opts, clbk )
function clbk( error, results ) {
if ( error ) {
throw new Error( error.message );
}
console.dir( results );
/* returns
{
"result": true
}
*/
}
The function
accepts the following options
:
- token: Travis CI access token (required).
- hostname: endpoint hostname. Default:
'api.travis-ci.org'
.
To authenticate with an endpoint, set the token
option.
var opts = {
'token': 'tkjorjk34ek3nj4!'
};
sync( opts, clbk );
By default, the function
syncs Travis CI for open source. To sync a different Travis CI API endpoint, set the hostname
option.
var opts = {
'token': 'tkjorjk34ek3nj4!',
'hostname': 'api.travis-ci.com'
};
sync( opts, clbk );
sync.factory( options, clbk )
Creates a reusable function
.
var opts = {
'token': 'tkjorjk34ek3nj4!',
'hostname': 'api.travis-ci.com'
};
var run = sync.factory( opts, clbk );
run();
run();
run();
// ...
The factory method accepts the same options
as sync()
.
Notes
- If the module encounters an application-level
error
while initially querying an endpoint (e.g., no network connection, malformed request, etc), thaterror
is returned immediately to the providedcallback
. - If possible, avoid repeatedly triggering a sync in close succession, as each sync may entail multiple Github API requests, thus affecting a user's Github rate limit.
Examples
var sync = require( 'travis-ci-sync' );
var opts = {
'token': 'tkjorjk34ek3nj4!'
};
sync( opts, clbk );
function clbk( error, results ) {
if ( error ) {
throw new Error( error.message );
}
console.log( results );
}
To run the example code from the top-level application directory,
$ node ./examples/index.js
Note: in order to run the example, you will need to obtain an access token and modify the token
option accordingly.
CLI
Installation
To use the module as a general utility, install the module globally
$ npm install -g travis-ci-sync
Usage
Usage: travissync [options]
Options:
-h, --help Print this message.
-V, --version Print the package version.
--hostname host Hostname. Default: api.travis-ci.org.
--token token Travis CI access token.
Notes
- In addition to the
token
option, the token may be specified by aTRAVISCI_TOKEN
environment variable. The command-line option always takes precedence.
Examples
Setting the access token using the command-line option:
$ DEBUG=* travissync --token <token>
Setting the access token using an environment variable:
$ DEBUG=* TRAVISCI_TOKEN=<token> travissync
For local installations, modify the command to point to the local installation directory; e.g.,
$ DEBUG=* ./node_modules/.bin/travissync --token <token>
Or, if you have cloned this repository and run npm install
, modify the command to point to the executable; e.g.,
$ DEBUG=* node ./bin/cli --token <token>
Tests
Unit
This repository uses tape for unit tests. To run the tests, execute the following command in the top-level application directory:
$ make test
All new feature development should have corresponding unit tests to validate correct functionality.
Test Coverage
This repository uses Istanbul as its code coverage tool. To generate a test coverage report, execute the following command in the top-level application directory:
$ make test-cov
Istanbul creates a ./reports/coverage
directory. To access an HTML version of the report,
$ make view-cov
Browser Support
This repository uses Testling for browser testing. To run the tests in a (headless) local web browser, execute the following command in the top-level application directory:
$ make test-browsers
To view the tests in a local web browser,
$ make view-browser-tests
License
Copyright
Copyright © 2016. Athan Reines.