public
Getting started
Overview
Before beginning integration, contact our customer success team to initiate an enterprise proof of concept (POC), or sign up directly from our website. (Launchable is free for open source projects.)
The Launchable CLI enables integration between your CI pipeline and Launchable. To get started,
- 1.install the CLI as part of your CI script,
- 2.set your Launchable API key, and
- 3.verify connectivity
Installing the CLI
The CLI requires both Python 3.5+ and Java 8+.
You can install the CLI in your CI pipeline by adding this to the part of your CI script where you install dependencies:
1
pip3 install --user --upgrade launchable~=1.0
Copied!
Setting your API key
First, create an API key at app.launchableinc.com. This authentication token allows the CLI to talk to Launchable.
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
CircleCI
GitHub Actions
GitLab CI
GoCD
Jenkins
(Create a global "secret text" to use in your job)
Travis CI
Verifying connectivity
After setting your API key, you can add
launchable verify || true to your script to verify connectivity. If successful, you should receive an output such as:1
$ launchable verify || true
2
​
3
Organization: <organization name>
4
Workspace: <workspace name>
5
Platform: macOS-11.4-x86_64-i386-64bit
6
Python version: 3.9.5
7
Java command: java
8
launchable version: 1.22.3
9
Your CLI configuration is successfully verified 🎉
Copied!
We recommend including
|| true so that the exit status from the command is always 0.Next steps
Now that you've added the CLI to your pipeline, you can start sending data to Launchable to analyze and optimize your test runs.
Last modified 1mo ago