https://github.com/prebuild/prebuild-ci

Use CI to auto upload prebuilds
https://github.com/prebuild/prebuild-ci

appveyor ci native-development prebuild travis

Last synced: about 1 month ago
JSON representation

Use CI to auto upload prebuilds

• Host: GitHub
• URL: https://github.com/prebuild/prebuild-ci
• Owner: prebuild
• Created: 2016-12-05T13:38:44.000Z (over 8 years ago)
• Default Branch: master
• Last Pushed: 2023-11-01T09:44:21.000Z (over 1 year ago)
• Last Synced: 2025-04-19T14:54:06.182Z (about 1 month ago)
• Topics: appveyor, ci, native-development, prebuild, travis
• Language: JavaScript
• Size: 44.9 KB
• Stars: 18
• Watchers: 2
• Forks: 4
• Open Issues: 3
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# prebuild-ci

Use CI like GitHub Actions, [Travis](https://travis-ci.org/) and [AppVeyor](https://www.appveyor.com/) to auto upload [prebuilds](https://github.com/prebuild/prebuild). Requires you to use `prebuild@6` or later.

[![npm](https://img.shields.io/npm/v/prebuild-ci.svg)](https://www.npmjs.com/package/prebuild-ci)

[![Node version](https://img.shields.io/node/v/prebuild-ci.svg)](https://www.npmjs.com/package/prebuild-ci)

[![Test](https://img.shields.io/github/workflow/status/prebuild/prebuild-ci/Test?label=test)](https://github.com/prebuild/prebuild-ci/actions/workflows/test.yml)

[![Standard](https://img.shields.io/badge/standard-informational?logo=javascript&logoColor=fff)](https://standardjs.com)

## Motivation

It's great to provide prebuilds with your native node modules, so consumers don't have to compile them on install - a pre made binary will simply be fetched.

It can however be cumbersome to create those binaries yourself, you need to run the appropriate scripts on every OS you desire to ship.

This module provides an alternative by creating and uploading those binaries in the CI environments you use, so for example using travis and appveyor you can

cover all node versions on mac OS, linux and windows, automatically!

## Usage

Add `prebuild-ci` to your `"test"` script or CI configuration, like this:

```json

  "scripts": {

    "test": "mocha && prebuild-ci"  

  }

```

Also configure your CI environments to set the environment variable `PREBUILD_TOKEN` to your [prebuild upload token](https://github.com/mafintosh/prebuild#create-github-token), and make sure this variable is only set on pull requests from the same repository.

Then, whenever a CI job passes _and_ updates `"version"` in the module's `package.json`, the prebuild for the current environment will be uploaded to GitHub.

That means that in order to have prebuilds for all desired os / node combinations, make sure to run each of those in a CI job.

__Pro Tip:__ In order for prebuilds to be available as soon as a new version is published to npm, wait with the actual `npm publish` until all the CI jobs have completed.

## Installation

```bash

$ npm install --save prebuild-ci

```

## License

MIT