From 038240bf1b04c8b2a9a8a5ab3653a3133fda0f55 Mon Sep 17 00:00:00 2001 From: MK Date: Thu, 6 Aug 2026 15:54:28 +0800 Subject: [PATCH 1/3] docs(ci): clarify setup-vp version pinning --- README.md | 4 +++- docs/guide/ci.md | 14 ++++++++++---- docs/guide/github-actions-cache.md | 4 +++- packages/cli/README.md | 4 +++- 4 files changed, 19 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index db19882f0a..ff1957999f 100644 --- a/README.md +++ b/README.md @@ -181,12 +181,14 @@ vp migrate Use the official [`setup-vp`](https://github.com/voidzero-dev/setup-vp) action to install Vite+ in GitHub Actions: ```yaml -- uses: voidzero-dev/setup-vp@v1 +- uses: voidzero-dev/setup-vp@ with: node-version: '22' cache: true ``` +Replace `` with the latest exact [`setup-vp` release tag](https://github.com/voidzero-dev/setup-vp/releases), or use a commit SHA. Do not use the `v1` tag: it is frozen and no longer receives updates. + #### Manual Installation & Migration If you are manually migrating a project to Vite+, install these dev dependencies first: diff --git a/docs/guide/ci.md b/docs/guide/ci.md index 916e5abd4c..b5cf4af0c4 100644 --- a/docs/guide/ci.md +++ b/docs/guide/ci.md @@ -6,12 +6,16 @@ You can use `voidzero-dev/setup-vp` to use Vite+ in CI environments. [`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. +## setup-vp Versioning + +Replace `` in the examples below with the latest [exact release tag](https://github.com/voidzero-dev/setup-vp/releases), or use a commit SHA. Do not use the `v1` tag: it is frozen and no longer receives updates. Renovate and Dependabot can update pinned tags. + ## 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. ```yaml [.github/workflows/ci.yml] -- uses: voidzero-dev/setup-vp@v1 +- uses: voidzero-dev/setup-vp@ with: node-version: '24' cache: true @@ -29,11 +33,13 @@ With `cache: true`, `setup-vp` handles dependency caching for you automatically. ## GitLab CI/CD -Use the reusable `setup-vp` remote template in your GitLab CI/CD configuration: +Use the reusable `setup-vp` remote template in your GitLab CI/CD configuration. Pin the remote URL and `setup-ref` to the same exact release tag: ```yaml [.gitlab-ci.yml] include: - - remote: 'https://raw.githubusercontent.com/voidzero-dev/setup-vp/v1/gitlab/setup-vp.yml' + - remote: 'https://raw.githubusercontent.com/voidzero-dev/setup-vp//gitlab/setup-vp.yml' + inputs: + setup-ref: '' test: extends: .setup-vp @@ -76,7 +82,7 @@ If you are migrating an existing GitHub Actions workflow, you can often replace #### After: ```yaml [.github/workflows/ci.yml] -- uses: voidzero-dev/setup-vp@v1 +- uses: voidzero-dev/setup-vp@ with: node-version: '24' cache: true diff --git a/docs/guide/github-actions-cache.md b/docs/guide/github-actions-cache.md index 5fbb4edae6..8521c0a94f 100644 --- a/docs/guide/github-actions-cache.md +++ b/docs/guide/github-actions-cache.md @@ -63,6 +63,8 @@ vp run lint # should print "cache hit" Restore `node_modules/.vite/task-cache` after `vp install`, because package installation can recreate or modify `node_modules`. +Replace `` below with the latest exact [`setup-vp` release tag](https://github.com/voidzero-dev/setup-vp/releases), or use a commit SHA. + ```yaml [.github/workflows/ci.yml] name: CI @@ -80,7 +82,7 @@ jobs: steps: - uses: actions/checkout@v4 - - uses: voidzero-dev/setup-vp@v1 + - uses: voidzero-dev/setup-vp@ with: node-version: '24' cache: true diff --git a/packages/cli/README.md b/packages/cli/README.md index 56f6bd17f4..833c9d82e6 100644 --- a/packages/cli/README.md +++ b/packages/cli/README.md @@ -175,12 +175,14 @@ vp migrate Use the official [`setup-vp`](https://github.com/voidzero-dev/setup-vp) action to install Vite+ in GitHub Actions: ```yaml -- uses: voidzero-dev/setup-vp@v1 +- uses: voidzero-dev/setup-vp@ with: node-version: '22' cache: true ``` +Replace `` with the latest exact [`setup-vp` release tag](https://github.com/voidzero-dev/setup-vp/releases), or use a commit SHA. Do not use the `v1` tag: it is frozen and no longer receives updates. + #### Manual Installation & Migration If you are manually migrating a project to Vite+, install these dev dependencies first: From f7914d9d452dad7c9522ff25a81b0c896407b0d4 Mon Sep 17 00:00:00 2001 From: MK Date: Thu, 6 Aug 2026 17:40:29 +0800 Subject: [PATCH 2/3] docs(ci): simplify setup-vp guidance --- README.md | 2 +- docs/guide/ci.md | 4 ++-- docs/guide/github-actions-cache.md | 2 +- packages/cli/README.md | 2 +- 4 files changed, 5 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index ff1957999f..4e84f7234b 100644 --- a/README.md +++ b/README.md @@ -187,7 +187,7 @@ Use the official [`setup-vp`](https://github.com/voidzero-dev/setup-vp) action t cache: true ``` -Replace `` with the latest exact [`setup-vp` release tag](https://github.com/voidzero-dev/setup-vp/releases), or use a commit SHA. Do not use the `v1` tag: it is frozen and no longer receives updates. +Set `` to an exact version from the [`setup-vp` releases page](https://github.com/voidzero-dev/setup-vp/releases). You can use a commit SHA instead. Do not use the `v1` tag. The `v1` tag no longer receives updates. #### Manual Installation & Migration diff --git a/docs/guide/ci.md b/docs/guide/ci.md index b5cf4af0c4..96606d710a 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. ## setup-vp Versioning -Replace `` in the examples below with the latest [exact release tag](https://github.com/voidzero-dev/setup-vp/releases), or use a commit SHA. Do not use the `v1` tag: it is frozen and no longer receives updates. Renovate and Dependabot can update pinned tags. +Set `` in each example to an exact version from the [`setup-vp` releases page](https://github.com/voidzero-dev/setup-vp/releases). You can use a commit SHA instead. Do not use the `v1` tag. The `v1` tag no longer receives updates. Renovate and Dependabot can update exact versions. ## GitHub Actions @@ -33,7 +33,7 @@ With `cache: true`, `setup-vp` handles dependency caching for you automatically. ## GitLab CI/CD -Use the reusable `setup-vp` remote template in your GitLab CI/CD configuration. Pin the remote URL and `setup-ref` to the same exact release tag: +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: ```yaml [.gitlab-ci.yml] include: diff --git a/docs/guide/github-actions-cache.md b/docs/guide/github-actions-cache.md index 8521c0a94f..cc1a62bfc7 100644 --- a/docs/guide/github-actions-cache.md +++ b/docs/guide/github-actions-cache.md @@ -63,7 +63,7 @@ vp run lint # should print "cache hit" Restore `node_modules/.vite/task-cache` after `vp install`, because package installation can recreate or modify `node_modules`. -Replace `` below with the latest exact [`setup-vp` release tag](https://github.com/voidzero-dev/setup-vp/releases), or use a commit SHA. +Set `` below to an exact version from the [`setup-vp` releases page](https://github.com/voidzero-dev/setup-vp/releases). You can use a commit SHA instead. ```yaml [.github/workflows/ci.yml] name: CI diff --git a/packages/cli/README.md b/packages/cli/README.md index 833c9d82e6..4b1a41c3f0 100644 --- a/packages/cli/README.md +++ b/packages/cli/README.md @@ -181,7 +181,7 @@ Use the official [`setup-vp`](https://github.com/voidzero-dev/setup-vp) action t cache: true ``` -Replace `` with the latest exact [`setup-vp` release tag](https://github.com/voidzero-dev/setup-vp/releases), or use a commit SHA. Do not use the `v1` tag: it is frozen and no longer receives updates. +Set `` to an exact version from the [`setup-vp` releases page](https://github.com/voidzero-dev/setup-vp/releases). You can use a commit SHA instead. Do not use the `v1` tag. The `v1` tag no longer receives updates. #### Manual Installation & Migration From a1757a91801ce5ebd296868461706ba5be315a82 Mon Sep 17 00:00:00 2001 From: MK Date: Fri, 7 Aug 2026 13:43:54 +0800 Subject: [PATCH 3/3] docs(ci): explain automated setup-vp updates --- README.md | 2 ++ docs/guide/ci.md | 29 ++++++++++++++++++++++++++++- docs/guide/github-actions-cache.md | 2 ++ packages/cli/README.md | 2 ++ 4 files changed, 34 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 4e84f7234b..ff84b3db14 100644 --- a/README.md +++ b/README.md @@ -189,6 +189,8 @@ Use the official [`setup-vp`](https://github.com/voidzero-dev/setup-vp) action t Set `` to an exact version from the [`setup-vp` releases page](https://github.com/voidzero-dev/setup-vp/releases). You can use a commit SHA instead. Do not use the `v1` tag. The `v1` tag no longer receives updates. +See [Automatic Version Updates](https://viteplus.dev/guide/ci#automatic-version-updates) to configure Dependabot or Renovate. + #### Manual Installation & Migration If you are manually migrating a project to Vite+, install these dev dependencies first: diff --git a/docs/guide/ci.md b/docs/guide/ci.md index 96606d710a..d6f035d709 100644 --- a/docs/guide/ci.md +++ b/docs/guide/ci.md @@ -8,7 +8,34 @@ You can use `voidzero-dev/setup-vp` to use Vite+ in CI environments. ## setup-vp Versioning -Set `` in each example to an exact version from the [`setup-vp` releases page](https://github.com/voidzero-dev/setup-vp/releases). You can use a commit SHA instead. Do not use the `v1` tag. The `v1` tag no longer receives updates. Renovate and Dependabot can update exact versions. +Set `` in each example to an exact version from the [`setup-vp` releases page](https://github.com/voidzero-dev/setup-vp/releases). 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](https://docs.github.com/en/code-security/dependabot/dependabot-version-updates/configuring-dependabot-version-updates), add a `github-actions` entry to `.github/dependabot.yml`: + +```yaml [.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](https://docs.renovatebot.com/modules/manager/github-actions/) 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: + +```yaml +- uses: voidzero-dev/setup-vp@ # +``` + +These settings apply only to GitHub Actions workflows. For GitLab CI/CD, update both version values together. ## GitHub Actions diff --git a/docs/guide/github-actions-cache.md b/docs/guide/github-actions-cache.md index cc1a62bfc7..ca2c0a24d1 100644 --- a/docs/guide/github-actions-cache.md +++ b/docs/guide/github-actions-cache.md @@ -65,6 +65,8 @@ Restore `node_modules/.vite/task-cache` after `vp install`, because package inst Set `` below to an exact version from the [`setup-vp` releases page](https://github.com/voidzero-dev/setup-vp/releases). You can use a commit SHA instead. +See [Automatic Version Updates](/guide/ci#automatic-version-updates) to configure Dependabot or Renovate. + ```yaml [.github/workflows/ci.yml] name: CI diff --git a/packages/cli/README.md b/packages/cli/README.md index 4b1a41c3f0..b2ebf48641 100644 --- a/packages/cli/README.md +++ b/packages/cli/README.md @@ -183,6 +183,8 @@ Use the official [`setup-vp`](https://github.com/voidzero-dev/setup-vp) action t Set `` to an exact version from the [`setup-vp` releases page](https://github.com/voidzero-dev/setup-vp/releases). You can use a commit SHA instead. Do not use the `v1` tag. The `v1` tag no longer receives updates. +See [Automatic Version Updates](https://viteplus.dev/guide/ci#automatic-version-updates) to configure Dependabot or Renovate. + #### Manual Installation & Migration If you are manually migrating a project to Vite+, install these dev dependencies first: