From 4f8dd4ad0f623952d7a18843680afc89b3ddd61c Mon Sep 17 00:00:00 2001 From: fengmk2 Date: Mon, 23 Mar 2026 03:05:45 +0000 Subject: [PATCH] docs(agents): add CI integration section to scaffolded AGENTS.md (#1088) Document `voidzero-dev/setup-vp` GitHub Action in the agent instructions template so coding agents generate correct CI workflows. Closes #1081 --- packages/cli/AGENTS.md | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/packages/cli/AGENTS.md b/packages/cli/AGENTS.md index f190a52347..adfdf836ed 100644 --- a/packages/cli/AGENTS.md +++ b/packages/cli/AGENTS.md @@ -69,6 +69,18 @@ These commands map to their corresponding tools. For example, `vp dev --port 300 - **Import JavaScript modules from `vite-plus`:** Instead of importing from `vite` or `vitest`, all modules should be imported from the project's `vite-plus` dependency. For example, `import { defineConfig } from 'vite-plus';` or `import { expect, test, vi } from 'vite-plus/test';`. You must not install `vitest` to import test utilities. - **Type-Aware Linting:** There is no need to install `oxlint-tsgolint`, `vp lint --type-aware` works out of the box. +## CI Integration + +For GitHub Actions, consider using [`voidzero-dev/setup-vp`](https://github.com/voidzero-dev/setup-vp) to replace separate `actions/setup-node`, package-manager setup, cache, and install steps with a single action. + +```yaml +- uses: voidzero-dev/setup-vp@v1 + with: + cache: true +- run: vp check +- run: vp test +``` + ## Review Checklist for Agents - [ ] Run `vp install` after pulling remote changes and before getting started.