Skip to main content

Bitrise

This section describes how to use ConfigCat's Bitrise Step to automatically scan your source code for feature flag and setting usages and upload the found code references to ConfigCat.

Bitrise is full-featured mobile CI/CD platform. You can find more information about Bitrise Steps here.

Setup

  1. Create a new ConfigCat Management API credential and store its values in secure pipeline variables with the following names: CONFIGCAT_API_USER, CONFIGCAT_API_PASS.

    Bitrise secrets
  2. Get your selected Config's ID.

  3. Add the following step to the workflows section of your bitrise.yml file. Don't forget to replace the PASTE-YOUR-CONFIG-ID-HERE value with your actual Config ID.

    - [email protected]:
    inputs:
    - configcat_config_id: 'PASTE-YOUR-CONFIG-ID-HERE'
  4. Commit & push your changes.

Scan reports are uploaded for each branch of your repository that triggers the job.

Available Options

ParameterDescriptionRequiredDefault
configcat_config_idThe config ID tells the step which feature flags it should search for in your source code.
configcat_api_hostConfigCat Management API host.api.configcat.com
line_countCode snippet line count before and after the reference line. (min: 1, max: 10)4
sub_folderSub-folder to scan, relative to the repository root folder.
verboseTurns on detailed logging.false