fab-upload

Builds and uploads a FAB to Linc.

fab-upload let's you enjoy the benefits of Linc without having to give up your existing CI solution.

Prerequisites

1. An existing Linc account.
2. A frontend project configured to output a FAB.

Getting started

Install @bitgenics/fab-upload-cli as a development dependency in your frontend project:

yarn add --dev @bitgenics/fab-upload-cli
npm install --dev @bitgenics/fab-upload-cli

Then add the following script to your package.json:

  {
    "scripts": {
      "build": "react-scripts build",
      "build:fab": "npm run fab-static build",
+     "fab-upload": "fab-upload"
    }
  }

Usage

@bitgenics/fab-upload-cli takes the following options:

USAGE
  $ fab-upload [SITENAME]

OPTIONS
  -a, --apiKey=apiKey  Your Linc site API key
  -h, --help           show CLI help

EXAMPLES
  $ fab-upload my-site-name

When fab-upload is run, it attempts to generate a FAB by running the build:fab script defined in your package.json.

Running the build:fab script should compile a FAB by using a relevant FAB package.

If a FAB is successfully compiled, fab-upload will then upload the FAB to Linc along with a record of the build as well as some related git metadata.

In order for fab-upload to operate, you will need to supply it with the name of your Linc site and an API key for that Linc site.

You can supply these two values as environment variables:

| Variable | Type | Value | | ---------------- | :----: | -------------------------: | | LINC_API_KEY | String | Your Linc site API key | | LINC_SITE_NAME | String | The name of your Linc site |

Alternatively, you can pass these values to fab-upload via the [SITENAME] argument and --apiKey flag as follows:

fab-upload my-site-name --apiKey=abcd1234

Once fab-upload has successfully uploaded a FAB to Linc, it will return a list of preview URLs for the FAB, as well as a link to the build log in the Linc interface.

Obtaining an API key

An API key for fab-upload can be obtained in Linc. See the External CI Linc docs for more info.