Continuous Integration

You can use voidzero-dev/setup-vp to use Vite+ in CI environments.

Overview

voidzero-dev/setup-vp provides integrations for GitHub Actions and GitLab CI/CD. Both install Vite+ and can install project dependencies. The GitHub Action can also set up Node.js and cache package manager data automatically, while the GitLab CI/CD template uses the Node.js runtime and cache configuration provided by the job.

setup-vp Versioning

Set <setup-vp-version> in each example to an exact version from the setup-vp releases page. You can use a commit SHA instead. Do not use the v1 tag. The v1 tag no longer receives updates.

Automatic Version Updates

Dependabot and Renovate can update exact versions in GitHub Actions workflows.

To use Dependabot version updates, add a github-actions entry to .github/dependabot.yml:

.github/dependabot.yml

version: 2
updates:
  - package-ecosystem: github-actions
    directory: /
    schedule:
      interval: weekly

Dependabot checks uses: entries in .github/workflows each week.

Renovate's GitHub Actions manager detects uses: entries by default. You do not need a package rule for setup-vp.

When you use a commit SHA, add the exact release tag in a comment. Renovate uses the comment to find updates:

- uses: voidzero-dev/setup-vp@<commit-sha> # <setup-vp-version>

These settings apply only to GitHub Actions workflows. For GitLab CI/CD, update both version values together.

GitHub Actions

The GitHub Action sets up Vite+, the required Node.js version, and the package manager. This means you usually do not need separate setup-node, package-manager setup, or manual dependency caching steps in your workflow.

.github/workflows/ci.yml

- uses: voidzero-dev/setup-vp@<setup-vp-version>
  with:
    node-version: '24'
    cache: true
    task-cache: true
- run: vp install
- run: vp check
- run: vp test
- run: vp build

Caching

Vite+ offers two different caching functions which interact with GitHub Actions Cache.

• With cache: true, setup-vp handles dependency caching for you automatically.
  • You can manually choose the lockfile manifest with cache-dependency-path, leaving it blank will auto-infer it for you.
• With task-cache: true, setup-vp handles saving and restoring the Vite+ task cache between runs for you.
  • Please read the GitHub Actions Cache page to learn more.

GitLab CI/CD

Use the reusable setup-vp remote template in your GitLab CI/CD configuration. Set the remote URL and setup-ref to the same release tag or commit SHA:

.gitlab-ci.yml

include:
  - remote: 'https://raw.githubusercontent.com/voidzero-dev/setup-vp/<setup-vp-version>/gitlab/setup-vp.yml'
    inputs:
      setup-ref: '<setup-vp-version>'

test:
  extends: .setup-vp
  image: node:24
  script:
    - vp check
    - vp test
    - vp build

The GitLab CI/CD integration differs from the GitHub Action in a few ways:

• The template does not install Node.js. Use a Node.js image, as shown above, or otherwise provide Node.js in the job.
• Configure dependency caching with the job's GitLab cache keyword.
• Use a Unix-like runner environment with Bash and either curl or wget.

For advanced configuration and the complete input reference, see the setup-vp GitLab CI/CD documentation.

Simplifying Existing Workflows

If you are migrating an existing GitHub Actions workflow, you can often replace large blocks of Node, package-manager, and cache setup with a single setup-vp step.

Before:

.github/workflows/ci.yml

- uses: pnpm/action-setup@v6
  with:
    version: 11

- uses: actions/setup-node@v6
  with:
    node-version: '24'
    cache: pnpm

- run: pnpm ci && pnpm dev:setup
- run: pnpm check
- run: pnpm test

After:

.github/workflows/ci.yml

- uses: voidzero-dev/setup-vp@<setup-vp-version>
  with:
    node-version: '24'
    cache: true

- run: vp install && vp run dev:setup
- run: vp check
- run: vp test