diff --git a/.github/workflows/pre-release.yml b/.github/workflows/pre-release.yml index cff10d736..96a56d054 100644 --- a/.github/workflows/pre-release.yml +++ b/.github/workflows/pre-release.yml @@ -2,8 +2,11 @@ name: Pre-release on: pull_request: - branches: - - main + branches: [main, experimental] + paths: + - packages/open-next/** + push: + branches: [main, experimental] paths: - packages/open-next/** diff --git a/README.md b/README.md index 020f4dff2..f01069cdd 100644 --- a/README.md +++ b/README.md @@ -36,7 +36,7 @@ OpenNext aims to support all Next.js 14 features. Some features are work in prog - [x] Image optimization - [x] [NextAuth.js](https://next-auth.js.org) - [x] Running at edge -- [x] [Almost no coldstart (*)](#coldstart) +- [x] [Almost no coldstart (\*)](#coldstart) ## Who is using OpenNext? @@ -56,6 +56,20 @@ This will output A LOT of additional logs to the console. This also disable mini You can read more about the configuration in the [docs](https://opennext.js.org/aws/config) +## Preleases + +Besides the standard npm releases we also automatically publish prerelease packages on branch pushes (using [`pkg.pr.new`](https://github.com/stackblitz-labs/pkg.pr.new)): + +- `https://pkg.pr.new/@opennextjs/aws@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/aws@experimental` + Updated with every push to the `experimental` branch, 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: + +```bash +npm i https://pkg.pr.new/@opennextjs/aws@main +``` ## Contribute