Sending data to Launchable


First, follow the steps in the Getting started guide to install the Launchable CLI, set your API key, and verify your connection.

Then return to this page to complete the two steps for sending data:

  1. Recording builds

  2. Recording test results

The diagram below diagrams the high-level data flow:

Recording builds

Launchable learns from and selects tests based on the Git changes in a build. To send changes to Launchable, run launchable record build before you create a build in your CI script:

launchable record build --name <BUILD NAME> --source src=<PATH TO SOURCE>
  • With the --name option, you assign a unique identifier to this build. You will use this value later when you request record test results. See Choosing a value for <BUILD NAME> for tips on choosing this value.

  • The --source option points to the local copy of the Git repository (or repositories) used to produce this build, such as . or src. See Data privacy and protection for more info.

Recording test results

Launchable also learns from your test results. After running tests, point the CLI to your test report files to collect test results for the build. Launchable uses the <BUILD NAME> value to connect the test results with the changes in the build:

launchable record tests --build <BUILD NAME> <TOOL NAME> <PATHS TO REPORT FILES>

The CLI natively integrates with the tools below. Click on the link to view instructions specific to your tool:

(Not using any of these? Try the generic file based test runner option.)

Next steps

Once you've started sending your builds and test results to Launchable, you can analyze your flaky tests and start subsetting your test runs.