# github-build

> Github builds/checks for CI

Latest version **1.2.4** (published 2023-11-21) · MIT license · 0 weekly downloads

## Install

```sh
npm install github-build
pnpm add github-build
yarn add github-build
bun add github-build
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.2.4 |
| Published | 2023-11-21 |
| First published | 2017-02-26 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 1 |
| Unpacked size | 4.5 KB |
| Known vulnerabilities | 0 (+29 in 1 direct dependencies) |
| Install scripts | no |
| GitHub stars | 134 |
| Author | siddharthkp |
| Maintainers | siddharthkp |
| Keywords | github, build, checks, ci |

## Links

- npm: https://www.npmjs.com/package/github-build
- Repository: https://github.com/siddharthkp/github-build
- Issues: https://github.com/siddharthkp/github-build/issues
- npm.io page: https://npm.io/package/github-build

## Dependencies (1)

- [axios](https://npm.io/package/axios.md) 1.6.0

## Alternatives

- [random-seedable](https://npm.io/package/random-seedable.md) — 27.9K weekly downloads
- [n2words](https://npm.io/package/n2words.md) — 22.2K weekly downloads
- [@stdlib/math-base-special-factorialln](https://npm.io/package/@stdlib/math-base-special-factorialln.md) — 5.7K weekly downloads
- [@stdlib/math-base-special-abs2](https://npm.io/package/@stdlib/math-base-special-abs2.md) — 1.7K weekly downloads
- [commons-math-interpolation](https://npm.io/package/commons-math-interpolation.md) — 1.4K weekly downloads

## Recent versions

- 1.2.4 (latest) — 2023-11-21
- 1.2.3 — 2021-10-09
- 1.2.2 — 2021-01-07
- 1.2.1 — 2019-06-13
- 1.2.0 — 2017-07-15
- 1.1.1 — 2017-06-11
- 1.1.0 — 2017-06-11
- 1.0.2 — 2017-02-26
- 1.0.1 — 2017-02-26
- 1.0.0 — 2017-02-26

## README

<p align="center">
  <img src="https://raw.githubusercontent.com/siddharthkp/github-build/master/art/logo.png" height="100px"/>
  <br><br>
  <b>Github builds/checks for CI</b>
  <br><br>

</p>
<p>
  <img src="https://raw.githubusercontent.com/siddharthkp/github-build/master/art/commit.png" height="200px"/>
  <br>
  <img src="https://raw.githubusercontent.com/siddharthkp/github-build/master/art/pull_request.png" height="250px"/>
</p>

&nbsp;

[![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)

&nbsp;

#### 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)

```

&nbsp;

If you like it then [you should put a ⭐️ on it](https://www.youtube.com/watch?v=4m1EFMoRFvY)

&nbsp;

#### License

MIT © siddharthkp

---
_Source: https://npm.io/package/github-build · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._