Skip to content

Commit 0696a1a

Browse files
committed
docs: Add edge channel to documentation
1 parent e193285 commit 0696a1a

File tree

1 file changed

+40
-0
lines changed

1 file changed

+40
-0
lines changed

docs/content/1.guide/1.getting-started/1.quick-start.md

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -169,3 +169,43 @@ description: ''
169169
### You're good to go!
170170

171171
Check out [how to use Pinia ORM](/guide/getting-started/usage){ .text-primary-500 }.
172+
173+
## Edge Channel
174+
175+
After each commit is merged into the `main` branch of `pinia-orm` and **passing all tests**, we trigger an automated npm release using Github Actions publishing a [`pinia-orm-edge`](https://npmjs.com/package/pinia-orm-edge) package.
176+
177+
This also happens for the other packages `@pinia-orm/nuxt-edge`, `@pinia-orm/normalizr-edge` and `@pinia-orm/axios-edge`.
178+
179+
You can opt in to use this release channel and avoid waiting for the next release and helping the module by beta testing changes.
180+
181+
The build and publishing method and quality of edge releases are the same as stable ones. The only difference is that you should often check the [GitHub repository](https://github.com/CodeDredd/pinia-orm) for updates. There is a slight chance of regressions not being caught during the review process and by the automated tests. Therefore, we internally use this channel to double-check everything before each release.
182+
183+
### Opting into the edge channel
184+
185+
Update `pinia-orm` dependency inside `package.json`:
186+
187+
```diff [package.json]
188+
{
189+
"devDependencies": {
190+
- "pinia-orm": "^1.0.0"
191+
+ "pinia-orm": "npm:pinia-orm-edge@latest"
192+
}
193+
}
194+
```
195+
196+
Remove lockfile (`package-lock.json`, `yarn.lock`, or `pnpm-lock.yaml`) and reinstall dependencies.
197+
198+
### Opting out from the edge channel
199+
200+
Update `pinia-orm` dependency inside `package.json`:
201+
202+
```diff [package.json]
203+
{
204+
"devDependencies": {
205+
- "pinia-orm": "npm:pinia-orm-edge@latest"
206+
+ "pinia-orm": "^1.0.0"
207+
}
208+
}
209+
```
210+
211+
Remove lockfile (`package-lock.json`, `yarn.lock`, or `pnpm-lock.yaml`) and reinstall dependencies.

0 commit comments

Comments
 (0)