Skip to content
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 5 additions & 1 deletion .github/workflows/prereleases.yml
Original file line number Diff line number Diff line change
@@ -1,6 +1,10 @@
name: Publish prereleases

on: pull_request
on:
push:
branches: [main, experimental]
pull_request:
branches: [main, experimental]

jobs:
release:
Expand Down
20 changes: 19 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,24 @@ The repository contains two directories:
- `packages` containing a cloudflare package that can be used to build a Cloudflare Workers-compatible output for Next.js applications.
- `examples` containing Next.js applications that use the above mentioned cloudflare package.

### How to try out/develop in the repository
### How to try out the `@opennextjs/cloudflare` package

You can simply install the package from npm as specified in the [OpenNext documentation](https://opennext.js.org/cloudflare/get-started).

> [!note]
> There are also prerelease packages that we automatically publish on branch pushes (using [`pkg.pr.new`](https://github.com/stackblitz-labs/pkg.pr.new)):
>
> - `https://pkg.pr.new/@opennextjs/cloudflare@main`:
>
> Updated with every push to the `main` branch, this prerelease contains the most up to date yet (reasonably) stable version of the package.
>
> - `https://pkg.pr.new/@opennextjs/cloudflare@experimental`
>
> Updated with every push to the `experimental` branch (when present), this prerelease contains the latest experimental version of the package (containing features
> that we want to test/experiment on before committing to).
>
> Which you can simply install directly with your package manager of choice, for example: `npm i https://pkg.pr.new/@opennextjs/cloudflare@main`

### How to develop in the repository

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