Getting started

Overview

To get started,
  1. 1.
    sign up for Launchable
  2. 2.
    install the Launchable CLI as part of your CI script,
  3. 3.
    set your Launchable API key, and
  4. 4.
    verify connectivity
Then follow the instructions for your test runner or build tool to start Sending data to Launchable.

Signing up for Launchable

Sign up at app.launchableinc.com/signup. You'll create a user account, an Organization for your company or organization, and a Workspace for your test suite.

Creating and setting your API key

Once you've created a Workspace for your test suite, create an API key in the Settings area. This authentication token lets the CLI talk to your Launchable workspace.
Then, make this API key available as the LAUNCHABLE_TOKEN environment variable in your CI process. How you do this depends on your CI system:
CI system
Docs
Azure DevOps Pipelines
Bitbucket Pipelines
GitHub Actions
Jenkins
(Create a global "secret text" to use in your job)
Travis CI

Adding the Launchable CLI to your CI pipeline

The Launchable CLI is a Python3 package that you can install from PyPI. The CLI connects your build tool/test runner to Launchable.
If you use pytest or nosetests, you don't need to use the Launchable CLI! We offer native plugins for those test runners. Check out the pytest and nose pages for more info.
You can install the CLI in your CI pipeline by adding this to the part of your CI script where you install dependencies. (If your build and test process is split into different pipelines or machines, you'll need to do this in both places.)
pip3 install --user --upgrade launchable~=1.0
The CLI requires both Python 3.5+ and Java 8+.

Verifying connectivity

After setting your API key and installing the CLI, you can add launchable verify || true to your CI script to verify that everything is set up right. If successful, you should receive an output such as:
$ launchable verify || true
Organization: <organization name>
Workspace: <workspace name>
Platform: <platform>
Python version: <version>
Java command: <command>
launchable version: <version>
Your CLI configuration is successfully verified 🎉
If you get an error, see Troubleshooting.
We recommend including || true after launchable verify so that the exit status from the command is always 0.

Next steps

Now that you've connected your Launchable workspace to your CI pipeline, you can start Sending data to Launchable to take advantage of Launchable's features.
Copy link
On this page
Overview
Signing up for Launchable
Creating and setting your API key
Adding the Launchable CLI to your CI pipeline
Verifying connectivity
Next steps