# fastboot-gitlab-notifier

> A FastBoot App Server notifier for GitLab build artifacts

Latest version **1.0.1** (published 2018-02-19) · MIT license · 0 weekly downloads

## Install

```sh
npm install fastboot-gitlab-notifier
pnpm add fastboot-gitlab-notifier
yarn add fastboot-gitlab-notifier
bun add fastboot-gitlab-notifier
```

## 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.0.1 |
| Published | 2018-02-19 |
| First published | 2016-05-16 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 1 |
| Unpacked size | 5.7 KB |
| Known vulnerabilities | 0 (+1 in 1 direct dependencies) |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Don Omondi |
| Maintainers | the-don-himself |
| Keywords | ember, fastboot, notifier, gitlab |

## Links

- npm: https://www.npmjs.com/package/fastboot-gitlab-notifier
- Repository: https://github.com/campus-discounts/fastboot-gitlab-notifier
- Homepage: https://github.com/campus-discounts/fastboot-gitlab-notifier#readme
- Issues: https://github.com/campus-discounts/fastboot-gitlab-notifier/issues
- npm.io page: https://npm.io/package/fastboot-gitlab-notifier

## Dependencies (1)

- [request](https://npm.io/package/request.md) latest

## Recent versions

- 1.0.1 (latest) — 2018-02-19
- 1.0.0 — 2017-08-17
- 0.0.0 — 2016-05-16

## README

## FastBoot GitLab Notifier

This notifier for the [FastBoot App Server][app-server] works with GitLab Builds to poll for new successful builds for a specified ref / branch.

[app-server]: https://github.com/ember-fastboot/fastboot-app-server

To use the notifier, configure it with your GitLab API token and your repo:

```js
const FastBootAppServer = require('fastboot-app-server');
const GitLabNotifier    = require('fastboot-gitlab-notifier');

let notifier = new GitLabNotifier({
  url:      'https://gitlab.com',           // Gitlab host e.g self hosted, defaults to https://gitlab.com
  token:    '1_A23CtFvGnsgdqwLPYZ',         // your Gitlab private token
  repo:     'my-app/ember.js',              // name of your repo
  branch:   'master',                       // optional, defaults to 'master'
  job:      'build',                        // optional, defaults to 'build'
  poll:     60 * 1000                       // optional polling interval, defaults to 60 * 1000 i.e every minute
});

let server = new FastBootAppServer({
  notifier: notifier
});
```

When the notifier starts, it will poll the API for the specified repository and branch. Once a new successful build is found, it will tell the FastBoot App Server to fetch the latest version of the app.

If you like this, you may also be interested in the companion [fastboot-gitlab-downloader](https://github.com/campus-discounts/fastboot-gitlab-downloader), which downloads the most recent build artifact for the specified ref.

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