Skip to main content

CircleCI Orb

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

Configuration

  1. Create a new ConfigCat Management API credential and store its values in CircleCI Environment Variables with the following names: CONFIGCAT_API_USER, CONFIGCAT_API_PASS.

  2. Get your selected Config's ID.

  3. Create a new CircleCI YAML config in your repository under the .circleci folder, and put the following snippet into it. Don't forget to replace the PASTE-YOUR-CONFIG-ID-HERE value with your actual Config ID.

    version: 2.1

    orbs:
    configcat: configcat/scan-[email protected]

    workflows:
    main:
    jobs:
    - configcat/scan:
    config-id: PASTE-YOUR-CONFIG-ID-HERE # required
    file-url-template: 'https://github.com/your/repo/blob/{commitHash}/{filePath}#L{lineNumber}' # optional, used to generate links to your repository
    commit-url-template: 'https://github.com/your/repo/commit/{commitHash}' # optional, used to generate links to your repository
  4. Commit & push your changes.

The above example configures a workflow that executes the scan and code reference upload on every git push event. Scan reports are uploaded for each branch of your repository that triggers the workflow.

Available Options

ParameterDescriptionRequiredDefault
config-idID of the ConfigCat config to scan against.โ˜‘
api-hostConfigCat Management API host.api.configcat.com
api-userName of the environment variable where the ConfigCat Management API basic authentication username is stored.CONFIGCAT_API_USER
api-passName of the environment variable where the ConfigCat Management API basic authentication password is stored.CONFIGCAT_API_PASS
file-url-templateTemplate url used to generate VCS file links. Available template parameters: commitHash, filePath, lineNumber. Example: https://github.com/my/repo/blob/{commitHash}/{filePath}#L{lineNumber}
commit-url-templateTemplate url used to generate VCS commit links. Available template parameters: commitHash. Example: https://github.com/my/repo/commit/{commitHash}
line-countContext 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