From a096610b70cbb8404a4b4f09efdf99a38e2dbab2 Mon Sep 17 00:00:00 2001 From: naokihaba <59875779+naokihaba@users.noreply.github.com> Date: Sun, 26 Jul 2026 21:58:12 +0900 Subject: [PATCH 1/5] docs: update CI documentation for GitHub Actions and GitLab CI/CD integration --- docs/guide/ci.md | 31 ++++++++++++++++++++++++++++--- 1 file changed, 28 insertions(+), 3 deletions(-) diff --git a/docs/guide/ci.md b/docs/guide/ci.md index a11a99fa18..0ff90b2a0f 100644 --- a/docs/guide/ci.md +++ b/docs/guide/ci.md @@ -4,12 +4,12 @@ You can use `voidzero-dev/setup-vp` to use Vite+ in CI environments. ## Overview -For GitHub Actions, the recommended setup is [`voidzero-dev/setup-vp`](https://github.com/voidzero-dev/setup-vp). It installs Vite+, sets up the required Node.js version and package manager, and can cache package installs automatically. - -That means you usually do not need separate `setup-node`, package-manager setup, and manual dependency-cache steps in your workflow. +[`voidzero-dev/setup-vp`](https://github.com/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. ## 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, and manual dependency-cache steps in your workflow. + ```yaml [.github/workflows/ci.yml] - uses: voidzero-dev/setup-vp@v1 with: @@ -27,6 +27,31 @@ With `cache: true`, `setup-vp` handles dependency caching for you automatically. `setup-vp` caches package-manager data. To reuse Vite Task results across CI runs, add a separate [GitHub Actions cache for Vite Task](/guide/github-actions-cache). ::: +## GitLab CI/CD + +Use the reusable `setup-vp` remote template in your GitLab CI/CD configuration: + +```yaml [.gitlab-ci.yml] +include: + - remote: 'https://raw.githubusercontent.com/voidzero-dev/setup-vp/v1/gitlab/setup-vp.yml' + +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`](https://docs.gitlab.com/ci/yaml/#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](https://github.com/voidzero-dev/setup-vp#gitlab-cicd). + ## 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. From 2fdfd0e9d9cafb899c4a75bbaec336e50fc6815c Mon Sep 17 00:00:00 2001 From: naokihaba <59875779+naokihaba@users.noreply.github.com> Date: Sun, 26 Jul 2026 21:59:48 +0900 Subject: [PATCH 2/5] docs: improve clarity in CI documentation for GitHub Actions and GitLab CI/CD --- docs/guide/ci.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/docs/guide/ci.md b/docs/guide/ci.md index 0ff90b2a0f..faf4ee48dc 100644 --- a/docs/guide/ci.md +++ b/docs/guide/ci.md @@ -4,11 +4,11 @@ You can use `voidzero-dev/setup-vp` to use Vite+ in CI environments. ## Overview -[`voidzero-dev/setup-vp`](https://github.com/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. +[`voidzero-dev/setup-vp`](https://github.com/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. ## 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, and manual dependency-cache steps in your workflow. +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. ```yaml [.github/workflows/ci.yml] - uses: voidzero-dev/setup-vp@v1 @@ -24,7 +24,7 @@ The GitHub Action sets up Vite+, the required Node.js version, and the package m With `cache: true`, `setup-vp` handles dependency caching for you automatically. ::: tip -`setup-vp` caches package-manager data. To reuse Vite Task results across CI runs, add a separate [GitHub Actions cache for Vite Task](/guide/github-actions-cache). +`setup-vp` caches package manager data. To reuse Vite Task results across CI runs, add a separate [GitHub Actions cache for Vite Task](/guide/github-actions-cache). ::: ## GitLab CI/CD @@ -54,7 +54,7 @@ For advanced configuration and the complete input reference, see the [`setup-vp` ## 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. +If you are migrating an existing GitHub Actions workflow, you can often replace large blocks of Node.js, package manager, and cache setup with a single `setup-vp` step. #### Before: From b28e5485c99d26d370d98b28a09d5c1340444ea0 Mon Sep 17 00:00:00 2001 From: naokihaba <59875779+naokihaba@users.noreply.github.com> Date: Sun, 26 Jul 2026 22:01:15 +0900 Subject: [PATCH 3/5] docs: fix typos in CI documentation for GitHub Actions --- docs/guide/ci.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/guide/ci.md b/docs/guide/ci.md index faf4ee48dc..a8ef4de9fc 100644 --- a/docs/guide/ci.md +++ b/docs/guide/ci.md @@ -8,7 +8,7 @@ You can use `voidzero-dev/setup-vp` to use Vite+ in CI environments. ## 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. +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. ```yaml [.github/workflows/ci.yml] - uses: voidzero-dev/setup-vp@v1 @@ -24,7 +24,7 @@ The GitHub Action sets up Vite+, the required Node.js version, and the package m With `cache: true`, `setup-vp` handles dependency caching for you automatically. ::: tip -`setup-vp` caches package manager data. To reuse Vite Task results across CI runs, add a separate [GitHub Actions cache for Vite Task](/guide/github-actions-cache). +`setup-vp` caches package-manager data. To reuse Vite Task results across CI runs, add a separate [GitHub Actions cache for Vite Task](/guide/github-actions-cache). ::: ## GitLab CI/CD From 1b14603e695e8dca682ae73610bf3bd31ec631e9 Mon Sep 17 00:00:00 2001 From: naokihaba <59875779+naokihaba@users.noreply.github.com> Date: Sun, 26 Jul 2026 22:01:36 +0900 Subject: [PATCH 4/5] docs: correct typo in CI documentation for GitHub Actions --- docs/guide/ci.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/guide/ci.md b/docs/guide/ci.md index a8ef4de9fc..3c6eff6ede 100644 --- a/docs/guide/ci.md +++ b/docs/guide/ci.md @@ -54,7 +54,7 @@ For advanced configuration and the complete input reference, see the [`setup-vp` ## Simplifying Existing Workflows -If you are migrating an existing GitHub Actions workflow, you can often replace large blocks of Node.js, package manager, and cache setup with a single `setup-vp` step. +If you are migrating an existing GitHub Actions workflow, you can often replace large blocks of Node.js, package-manager, and cache setup with a single `setup-vp` step. #### Before: From 7c9ee2fa10504b722be6aa1e970e41bd7a39bab9 Mon Sep 17 00:00:00 2001 From: naokihaba <59875779+naokihaba@users.noreply.github.com> Date: Sun, 26 Jul 2026 22:02:01 +0900 Subject: [PATCH 5/5] docs: clarify wording in CI documentation for GitHub Actions migration --- docs/guide/ci.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/guide/ci.md b/docs/guide/ci.md index 3c6eff6ede..916e5abd4c 100644 --- a/docs/guide/ci.md +++ b/docs/guide/ci.md @@ -54,7 +54,7 @@ For advanced configuration and the complete input reference, see the [`setup-vp` ## Simplifying Existing Workflows -If you are migrating an existing GitHub Actions workflow, you can often replace large blocks of Node.js, package-manager, and cache setup with a single `setup-vp` step. +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: