# lyne-helper-trigger-travis

> Helper to trigger a build on TravisCI via Travis API v3

Latest version **1.0.6** (published 2021-06-20) · ISC license · 0 weekly downloads

> **Deprecated.** This package is deprecated.

## Install

```sh
npm install lyne-helper-trigger-travis
pnpm add lyne-helper-trigger-travis
yarn add lyne-helper-trigger-travis
bun add lyne-helper-trigger-travis
```

## Health

**Score 10/100 (F)** — status: deprecated.

Negative: deprecated.

## Facts

| | |
|---|---|
| Version | 1.0.6 |
| Published | 2021-06-20 |
| First published | 2020-09-09 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 38.8 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Maintainers | lyne-design-system |

## Links

- npm: https://www.npmjs.com/package/lyne-helper-trigger-travis
- Repository: https://github.com/lyne-design-system/lyne-helper-trigger-travis
- Homepage: https://github.com/lyne-design-system/lyne-helper-trigger-travis/blob/master/README.md
- Issues: https://github.com/lyne-design-system/lyne-helper-trigger-travis/issues
- npm.io page: https://npm.io/package/lyne-helper-trigger-travis

## Recent versions

- 1.0.6 (latest) — 2021-06-20
- 1.0.5 — 2021-06-20
- 1.0.4 — 2021-06-20
- 1.0.3 — 2020-09-13
- 1.0.2 — 2020-09-13
- 1.0.1 — 2020-09-09
- 1.0.0 — 2020-09-09

## README

[![Build Status](https://travis-ci.com/lyne-design-system/lyne-helper-trigger-travis.svg?branch=master)](https://travis-ci.com/lyne-design-system/lyne-helper-trigger-travis) [![semantic-release](https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg)](https://github.com/semantic-release/semantic-release) ![GitHub tag (latest SemVer)](https://img.shields.io/github/v/tag/lyne-design-system/lyne-helper-trigger-travis?label=release)

# Lyne Helper Trigger Travis

Trigger a build on TravisCI via Travis API v3.

## Installation

Install the Helper with the following command:
```bash
npm install --save lyne-helper-trigger-travis
```

## Usage

Require the module:

```
const triggerTravis = require('lyne-helper-trigger-travis');
```

Build up your config:

```
const config = {
  branchName: 'BRANCH_NAME',
  message: 'MESSAGE',
  travisToken: 'TRAVIS_TOKEN',
  travisUrl: 'TRAVIS_URL'
};
```

The module has a single method which returns a promise. You can use it as follows:

```
triggerTravis(config)
  .then((data) => {
    if (data) {
      console.log(data);
    }
  })
  .catch((err) => {
    console.log(err);
  });
```

### Config

`branchName`: the branch on which the job should trigger

`message`: the message which acts as the commit message for the build

`travisToken`: the access token from your travis account

`travisUrl`: the url to the travis project.

#### travisUrl
The Schema is as follows: https://api.travis-ci.com/repo/{slug|id}/requests.

If you use travis.com, please use https://api.travis-ci.com/repo/{slug|id}/requests.

Example for a project on travis.com with the user name `lyne-design-system` and the repo name `lyne-design-tokens`: https://api.travis-ci.com/repo/lyne-design-system%2Flyne-design-tokens/requests

## Development

### Conventional Commits

Please follow the [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/) specification to make sure we can automatically determine the next release version if necessary.

### Deployment

The package is automatically versioned and published to npm after successfull build on travis.

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