Skip to main content

GitLab: Feature Flag Code Usages

Overview

With this GitLab CI/CD pipeline, your DevCycle dashboard will be updated to display code snippets for each DevCycle variable usage within your project.

Note: This is intended to run when pushing changes to your main branch.

Example Output

Example Output

Usage

Create a new .gitlab-ci.yml file in your GitLab repository or update the existing one. Add the code_usages stage and paste the following code into a code_usages:

stages:
- code_usages

code_usages:
stage: code_usages
image: node:latest
before_script:
- rm -rf devcycle-usages-ci-cd
script:
- apt-get update && apt-get install -y jq
- export PATH=$(npm bin -g):$PATH
- git clone https://gitlab.com/devcycle/devcycle-usages-ci-cd.git
- node devcycle-usages-ci-cd/dist/index.js
only:
- main

Your DevCycle API credentials and project token are required to update the DevCycle dashboard.

When referencing your API client ID and secret, we recommend using GitLab CI/CD variables to store your credentials securely.

Environment Variables

Your DevCycle API credentials and project token are required to update the DevCycle dashboard. These should be set as environment variables in your GitLab project settings:

VariableDescription
DVC_PROJECT_KEYYour DevCycle project key, see Projects
DVC_CLIENT_IDYour organization's API client ID, see Organization Settings
DVC_CLIENT_SECRETYour organization's API client secret, see Organization Settings

When setting these environment variables, we recommend you protect them to ensure they're only exposed to protected branches or tags and mask them to hide their values in job logs.

Usage

  1. Set the necessary environment variables in your GitLab project settings as described above.
  2. Add the provided .gitlab-ci.yaml to your project root.
  3. Push your changes. The pipeline should run automatically when you push changes to your main branch.

Support

For any issues, feedback, or questions, please feel free to open an issue on this repository.