The Launchable CLI enables integration between your CI pipeline and Launchable. To get started,
install the CLI as part of your CI script,
set your Launchable API key, and
Then follow the instructions for your test runner or build tool to send data to Launchable.
The Launchable CLI is a Python3 package that you can install from PyPI.
You can install the CLI in your CI pipeline by adding this to the part of your CI script where you install dependencies:
pip3 install --user --upgrade launchable~=1.0
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:
Azure DevOps Pipelines
(Create a global "secret text" to use in your job)
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:
$ launchable verify || trueOrganization: <organization name>Workspace: <workspace name>Platform: macOS-11.4-x86_64-i386-64bitPython version: 3.9.5Java command: javalaunchable version: 1.22.3Your CLI configuration is successfully verified 🎉
If you get an error, see Troubleshooting.
Now that you've added the CLI to your pipeline, you can start sending data to Launchable to analyze and optimize your test runs.