1.0.0-beta.1 • Published 5 years ago

speedcurve-deploy v1.0.0-beta.1

Weekly downloads
7
License
ISC
Repository
github
Last release
5 years ago

SpeedCurve Deploy

Define and run SpeedCurve tests from the command line. With speedcurve-deploy, you use a .speedcurve.json file to configure the tests that you want to run. Then, using a single command, you run the tests on-demand and optionally wait to receive results.

Installation

SpeedCurve Deploy requires Node.js version 8 or higher. It can be installed by running:

npm install -g speedcurve-deploy

Basic usage

Run speedcurve-deploy in a directory containing a .speedcurve.json file to run SpeedCurve tests:

speedcurve-deploy --note 'v2.11.8' --detail 'Inline critical CSS, bootstrap app on DOMContentLoaded'

The --note (a short description of the deploy) and --detail (longer details of the deploy) flags are both optional but are recommended to help you identify deploys in the SpeedCurve UI.

Configuration

SpeedCurve Deploy is configured with a .speedcurve.json file, which looks like this:

{
  "teams": [
    {
      "key": "******",
      "sites": [41774, 70313, 70315]
    },
    {
      "key": "******"
    }
  ]
}

The root object has an teams property which is an array of teams objects, each representing a SpeedCurve teams. See below for a description of the teams object properties.

PropertyDescriptionDefault
keyRequired. API key for the team.Not set
sitesOptional. Array of site IDs to trigger tests for.All sites in the team