Integrating the Vega SDK into CI Pipelines

This page describes how to integrate the Vega SDK into Continuous Integration (CI) pipelines, including automated installation processes and configuration requirements.

A build host is the machine (virtual or physical) that builds your Vega app as part of a CI pipeline. The Vega SDK provides an installation command on the installation instructions page that can run non-interactively, avoiding user input to facilitate automated SDK installation on a build host.

Prerequisites

Before integrating the Vega SDK into your CI pipeline, make sure that your build environment meets the following requirements. Pay particular attention to selecting the correct platform for your build host, as choosing the wrong platform can lead to installation or runtime errors.

System requirements

Host configurations

• Operating system
  • Ubuntu 20.04 or higher
    • x86_64
  • Mac OS X
    • arm64 (M-series) or x86_64 (Intel)

Installation process

The Vega SDK installation process needs special consideration when implementing it in a CI environment. Unlike developer workstations where interactive installation is common, CI environments require a fully automated approach. The following sections guide you through this process.

Basic installation

1. Edit the installation command to disable installer prompts that can interrupt an automated installation.

   export NONINTERACTIVE=true
   

2. Configure the desired installation flags.

   # Skip VVD Installation.
   export SKIP_VVD_INSTALL=true
   
   # Install specific sdk version.
   export VEGA_SDK_VERSION=0.21.5245
   
   # Download and run the installer script.
   curl -fsSL https://sdk-installer.vega.labcollab.net/get_vvm.sh | bash
   

For additional configuration options, see the following sections.

Environment variable configuration

Use the following environment variables to control the installer script.

Docker integration

Docker provides a consistent and isolated environment for building applications with the Vega SDK. The following example demonstrates how to create a build environment that includes all necessary dependencies and configurations. This approach can be adapted for various CI solutions that support container-based builds.

Example dockerfile

FROM --platform=linux/amd64 ubuntu:22.04

ENV DEBIAN_FRONTEND=noninteractive

RUN apt-get update && apt-get install -y \
    curl tar jq ca-certificates \
    && rm -rf /var/lib/apt/lists/*

ENV NONINTERACTIVE=true

# SDK configuration
ARG VEGA_SDK_VERSION=0.21.5245
ARG SKIP_SDK_INSTALL=false

ENV VEGA_SDK_VERSION=${VEGA_SDK_VERSION}
ENV SKIP_SDK_INSTALL=${SKIP_SDK_INSTALL}

RUN curl -fsSL https://sdk-installer.vega.labcollab.net/get_vvm.sh | bash

ENV PATH="/root/vega/bin:${PATH}"

RUN vega -v

CMD ["/bin/bash"]

For more information, see Manage Your SDK Versions.

Last updated: Jan 06, 2026