Integrating the Vega SDK into CI Pipelines

​

Prerequisites

​

System requirements

​

Host configurations

• Operating system
  • Ubuntu 20.04, 22.04, or 24.04
    • x86_64
  • Mac OS X
    • arm64 (M-series) — recommended
    • x86_64 (Intel)

​

Installation 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 a specific SDK version.
   export VEGA_SDK_VERSION=0.24.9311
   
   # Download and run the installer script.
   curl -fsSL https://sdk-installer.vega.labcollab.net/get_vvm.sh | bash
   

​

Environment variable configuration

​

Docker integration

​

Example Dockerfile

FROM --platform=linux/amd64 ubuntu:22.04

SHELL ["/bin/bash", "-c"]

ENV DEBIAN_FRONTEND=noninteractive

# Install cURL and utilities to fetch the installer.
RUN apt-get update && \
    apt-get install -y curl tar jq ca-certificates --no-install-recommends && \
    rm -rf /var/lib/apt/lists/*

# Install Vega SDK.
ENV NONINTERACTIVE=true

ARG VEGA_SDK_VERSION=0.24.9311
ARG SKIP_VVD_INSTALL=true

ENV VEGA_SDK_VERSION=${VEGA_SDK_VERSION}
ENV SKIP_VVD_INSTALL=${SKIP_VVD_INSTALL}

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

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

# Verify the vega command is available.
RUN vega -v

# React Native apps require Node.js and npm.
RUN apt-get update && apt-get install -y nodejs npm --no-install-recommends && rm -rf /var/lib/apt/lists/*

# Set the global npm config path and bind mount your npmrc config to this location.
ENV NPM_CONFIG_GLOBALCONFIG="/etc/npmrc"

# Verify node and npm commands are available.
RUN node -v && npm -v

ENTRYPOINT [ "/bin/bash", "-c" ]

docker build . --tag vega-sdk \
  --build-arg VEGA_SDK_VERSION=0.24.9311 \
  --build-arg SKIP_VVD_INSTALL=true

​

Best practices

​

Version control

• Always specify exact SDK versions in your CI configuration using VEGA_SDK_VERSION.
• Use version pinning for stability and reproducible builds.
• Document version updates in your repository changelog.

​

Performance optimization

• Set SKIP_VVD_INSTALL=true when device emulation isn’t needed—it significantly reduces installation size.
• Use caching strategies for downloaded artifacts.
• Consider multi-stage Docker builds to keep final image sizes small.

​

Security

• Always use HTTPS download URLs.
• Implement proper access controls for private npm registries.
• Regularly audit your CI/CD pipeline configuration.

​

Troubleshooting

​

Installation failures

• Verify network connectivity to SDK repositories.
• Ensure sufficient disk space for the SDK installation.
• Check that environment variables are set correctly.
• Confirm you selected the correct platform for your build host on the installation page.

​

Build errors

• Verify SDK version compatibility with your app.
• Check for missing dependencies in your build environment.
• Review build logs for specific error messages.
• Confirm the correct platform was selected during installation.
• Confirm your manifest.toml includes the [os.version] section. Starting with SDK 0.24, builds fail without it. Run vega project update-manifest --os-min 1.2 --os-version 1.2 in your project before building, or add the section to your committed manifest.toml.