Skip to content

Commit 58cae1d

Browse files
committed
docs: Add edge releases channel
1 parent 3adf4e5 commit 58cae1d

File tree

1 file changed

+44
-0
lines changed

1 file changed

+44
-0
lines changed
Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
1+
---
2+
title: Edge Channel
3+
description: Nuxt Content is landing commits, improvements, and bug fixes every day. You can opt-in to test them earlier before the next release.
4+
---
5+
6+
After each commit is merged into the `main` branch of [nuxt/content](https://github.com/nuxt/content) and **passing all tests**, we trigger an automated npm release using Github Actions publishing a `@nuxt/content-edge` package.
7+
8+
You can opt in to use this release channel and avoid waiting for the next release and helping the module by beta testing changes.
9+
10+
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/nuxt/content) 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.
11+
12+
::alert
13+
Features only available on the edge channel are marked with an alert in the documentation.
14+
::
15+
16+
## Opting into the edge channel
17+
18+
Update `@nuxt/content` dependency inside `package.json`:
19+
20+
```diff [package.json]
21+
{
22+
"devDependencies": {
23+
-- "@nuxt/content": "^2.0.0"
24+
++ "@nuxt/content": "npm:@nuxt/content@latest"
25+
}
26+
}
27+
```
28+
29+
Remove lockfile (`package-lock.json`, `yarn.lock`, or `pnpm-lock.yaml`) and reinstall dependencies.
30+
31+
## Opting out from the edge channel
32+
33+
Update `@nuxt/content` dependency inside `package.json`:
34+
35+
```diff [package.json]
36+
{
37+
"devDependencies": {
38+
-- "@nuxt/content": "npm:@nuxt/content@latest"
39+
++ "@nuxt/content": "^2.0.0"
40+
}
41+
}
42+
```
43+
44+
Remove lockfile (`package-lock.json`, `yarn.lock`, or `pnpm-lock.yaml`) and reinstall dependencies.

0 commit comments

Comments
 (0)