Skip to content

Commit 4f8dd4a

Browse files
committed
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
1 parent d0b0d3e commit 4f8dd4a

1 file changed

Lines changed: 12 additions & 0 deletions

File tree

packages/cli/AGENTS.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -69,6 +69,18 @@ These commands map to their corresponding tools. For example, `vp dev --port 300
6969
- **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.
7070
- **Type-Aware Linting:** There is no need to install `oxlint-tsgolint`, `vp lint --type-aware` works out of the box.
7171

72+
## CI Integration
73+
74+
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.
75+
76+
```yaml
77+
- uses: voidzero-dev/setup-vp@v1
78+
with:
79+
cache: true
80+
- run: vp check
81+
- run: vp test
82+
```
83+
7284
## Review Checklist for Agents
7385
7486
- [ ] Run `vp install` after pulling remote changes and before getting started.

0 commit comments

Comments
 (0)