github-build

WebJar for github-build

License	MIT
Categories	Github Development Tools Version Controls
GroupId	org.webjars.npm
ArtifactId	github-build
Last Version	1.2.0
Release Date	Jan 24, 2019
Type	jar
Description	github-build WebJar for github-build
Project URL	http://webjars.org
Source Code Management	https://github.com/siddharthkp/github-build

Download github-build

Filename	Size
github-build-1.2.0.pom
github-build-1.2.0.jar	5 KB
github-build-1.2.0-sources.jar	22 bytes
github-build-1.2.0-javadoc.jar	22 bytes

How to add to project

Apache Maven

<!-- https://jarcasting.com/artifacts/org.webjars.npm/github-build/ -->
<dependency>
    <groupId>org.webjars.npm</groupId>
    <artifactId>github-build</artifactId>
    <version>1.2.0</version>
</dependency>

Gradle Groovy

// https://jarcasting.com/artifacts/org.webjars.npm/github-build/
implementation 'org.webjars.npm:github-build:1.2.0'

Gradle Kotlin

// https://jarcasting.com/artifacts/org.webjars.npm/github-build/
implementation ("org.webjars.npm:github-build:1.2.0")

Apache Buildr

'org.webjars.npm:github-build:jar:1.2.0'

Apache Ivy

<dependency org="org.webjars.npm" name="github-build" rev="1.2.0">
  <artifact name="github-build" type="jar" />
</dependency>

Groovy Grape

@Grapes(
@Grab(group='org.webjars.npm', module='github-build', version='1.2.0')
)

Scala SBT

libraryDependencies += "org.webjars.npm" % "github-build" % "1.2.0"

Leiningen

[org.webjars.npm/github-build "1.2.0"]

Dependencies

compile (1)

Group / Artifact	Type	Version
org.webjars.npm : axios	jar	[0.15.3]

Project Modules

There are no modules declared in this project.

Github builds/checks for CI

 

 

Install

npm install github-build --save

Usage

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

Versions

Version
1.2.0 Jan 24, 2019