https://github.com/siddharthkp/github-build

Github builds for CI
https://github.com/siddharthkp/github-build

build checks ci github

Last synced: 6 days ago
JSON representation

Github builds for CI

• Host: GitHub
• URL: https://github.com/siddharthkp/github-build
• Owner: siddharthkp
• License: mit
• Created: 2017-02-26T11:52:08.000Z (almost 8 years ago)
• Default Branch: main
• Last Pushed: 2024-03-16T20:30:22.000Z (10 months ago)
• Last Synced: 2024-05-21T10:56:34.812Z (7 months ago)
• Topics: build, checks, ci, github
• Language: JavaScript
• Homepage:
• Size: 295 KB
• Stars: 133
• Watchers: 3
• Forks: 7
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        


  

  



  Github builds/checks for CI

  







  

  


  



 

[![Code Climate](https://lima.codeclimate.com/github/siddharthkp/github-build/badges/gpa.svg)](https://lima.codeclimate.com/github/siddharthkp/github-build)

[![Known Vulnerabilities](https://snyk.io/test/github/siddharthkp/github-build/badge.svg)](https://snyk.io/test/github/siddharthkp/github-build)

 

#### Install

```

npm install github-build --save

```

#### Usage

```js

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](https://www.youtube.com/watch?v=4m1EFMoRFvY)

 

#### License

MIT © siddharthkp