Skip to content

Commit 69f005e

Browse files
add branch prereleases
1 parent 30bab8d commit 69f005e

File tree

2 files changed

+24
-2
lines changed

2 files changed

+24
-2
lines changed

.github/workflows/prereleases.yml

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,10 @@
11
name: Publish prereleases
22

3-
on: pull_request
3+
on:
4+
push:
5+
branches: [main, experimental]
6+
pull_request:
7+
branches: [main, experimental]
48

59
jobs:
610
release:

README.md

Lines changed: 19 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,24 @@ The repository contains two directories:
1717
- `packages` containing a cloudflare package that can be used to build a Cloudflare Workers-compatible output for Next.js applications.
1818
- `examples` containing Next.js applications that use the above mentioned cloudflare package.
1919

20-
### How to try out/develop in the repository
20+
### How to try out the `@opennextjs/cloudflare` package
21+
22+
You can simply install the package from npm as specified in the [OpenNext documentation](https://opennext.js.org/cloudflare/get-started).
23+
24+
> [!note]
25+
> There are also prerelease packages that we automatically publish on branch pushes (using [`pkg.pr.new`](https://github.com/stackblitz-labs/pkg.pr.new)):
26+
>
27+
> - `https://pkg.pr.new/@opennextjs/cloudflare@main`:
28+
>
29+
> Updated with every push to the `main` branch, this prerelease contains the most up to date yet (reasonably) stable version of the package.
30+
>
31+
> - `https://pkg.pr.new/@opennextjs/cloudflare@experimental`
32+
>
33+
> Updated with every push to the `experimental` branch (when present), this prerelease contains the latest experimental version of the package (containing features
34+
> that we want to test/experiment on before committing to).
35+
>
36+
> Which you can simply install directly with your package manager of choice, for example: `npm i https://pkg.pr.new/@opennextjs/cloudflare@main`
37+
38+
### How to develop in the repository
2139

2240
See the [CONTRIBUTING](./CONTRIBUTING.md) page for how to get started with this repository.

0 commit comments

Comments
 (0)