Skip to content

Commit a1757a9

Browse files
committed
docs(ci): explain automated setup-vp updates
1 parent f7914d9 commit a1757a9

4 files changed

Lines changed: 34 additions & 1 deletion

File tree

README.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -189,6 +189,8 @@ Use the official [`setup-vp`](https://github.com/voidzero-dev/setup-vp) action t
189189
190190
Set `<setup-vp-version>` 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.
191191

192+
See [Automatic Version Updates](https://viteplus.dev/guide/ci#automatic-version-updates) to configure Dependabot or Renovate.
193+
192194
#### Manual Installation & Migration
193195

194196
If you are manually migrating a project to Vite+, install these dev dependencies first:

docs/guide/ci.md

Lines changed: 28 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,34 @@ You can use `voidzero-dev/setup-vp` to use Vite+ in CI environments.
88

99
## setup-vp Versioning
1010

11-
Set `<setup-vp-version>` 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.
11+
Set `<setup-vp-version>` 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.
12+
13+
### Automatic Version Updates
14+
15+
Dependabot and Renovate can update exact versions in GitHub Actions workflows.
16+
17+
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`:
18+
19+
```yaml [.github/dependabot.yml]
20+
version: 2
21+
updates:
22+
- package-ecosystem: github-actions
23+
directory: /
24+
schedule:
25+
interval: weekly
26+
```
27+
28+
Dependabot checks `uses:` entries in `.github/workflows` each week.
29+
30+
[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`.
31+
32+
When you use a commit SHA, add the exact release tag in a comment. Renovate uses the comment to find updates:
33+
34+
```yaml
35+
- uses: voidzero-dev/setup-vp@<commit-sha> # <setup-vp-version>
36+
```
37+
38+
These settings apply only to GitHub Actions workflows. For GitLab CI/CD, update both version values together.
1239

1340
## GitHub Actions
1441

docs/guide/github-actions-cache.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -65,6 +65,8 @@ Restore `node_modules/.vite/task-cache` after `vp install`, because package inst
6565

6666
Set `<setup-vp-version>` 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.
6767

68+
See [Automatic Version Updates](/guide/ci#automatic-version-updates) to configure Dependabot or Renovate.
69+
6870
```yaml [.github/workflows/ci.yml]
6971
name: CI
7072

packages/cli/README.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -183,6 +183,8 @@ Use the official [`setup-vp`](https://github.com/voidzero-dev/setup-vp) action t
183183
184184
Set `<setup-vp-version>` 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.
185185

186+
See [Automatic Version Updates](https://viteplus.dev/guide/ci#automatic-version-updates) to configure Dependabot or Renovate.
187+
186188
#### Manual Installation & Migration
187189

188190
If you are manually migrating a project to Vite+, install these dev dependencies first:

0 commit comments

Comments
 (0)