Package Exports
- github-build
This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (github-build) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.
Readme
Github builds/checks for CI
Install
npm install github-build --saveUsage
const Build = require('github-build')
const data = {
repo: 'siddharthkp/github-build', // (author/repo)
sha: '6954e71d46be1ae9b0529aae6e00b64d7a1023d4', // (commit sha)
token: 'secret', // (github oauth token: https://developer.github.com/v3/oauth)
label: 'my CI service',
description: 'checking some stuff',
url: 'http://my-ci-service.com/builds/1', // details url
}
/* Create a build */
const build = new Build(data)
/* When you call start, a pending status get's added on github (returns a promise) */
build.start()
/* Run your tests */
/* If things go well, call pass, it will mark change the status to success ✅ (returns a promise) */
build.pass()
/* Or if the tests fail, mark this build as failed ❌ (returns a promise) */
build.fail()
/* If you could not run the tests because of incorrect config, just error out the build (returns a promise) */
build.error() // use when build errors out (returns a promise)
If you like it then you should put a ⭐️ on it
License
MIT © siddharthkp