From 69f005e1ecd9daf23d66a96c843e0cb672e1262b Mon Sep 17 00:00:00 2001 From: Dario Piotrowicz Date: Thu, 31 Oct 2024 19:01:47 +0000 Subject: [PATCH 1/3] add branch prereleases --- .github/workflows/prereleases.yml | 6 +++++- README.md | 20 +++++++++++++++++++- 2 files changed, 24 insertions(+), 2 deletions(-) diff --git a/.github/workflows/prereleases.yml b/.github/workflows/prereleases.yml index c5b1d501..a52603a2 100644 --- a/.github/workflows/prereleases.yml +++ b/.github/workflows/prereleases.yml @@ -1,6 +1,10 @@ name: Publish prereleases -on: pull_request +on: + push: + branches: [main, experimental] + pull_request: + branches: [main, experimental] jobs: release: diff --git a/README.md b/README.md index 48d27943..b1ae1989 100644 --- a/README.md +++ b/README.md @@ -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. From d5a263fc352cccc41f3e4328c70f26d09bde4481 Mon Sep 17 00:00:00 2001 From: Dario Piotrowicz Date: Fri, 1 Nov 2024 09:43:48 +0000 Subject: [PATCH 2/3] Update README.md Co-authored-by: Victor Berchet --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index b1ae1989..876b6185 100644 --- a/README.md +++ b/README.md @@ -33,7 +33,7 @@ You can simply install the package from npm as specified in the [OpenNext docume > 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` +> Which you can simply install directly with your package manager of choice, for example: `npm i https://pkg.pr.new/@opennextjs/cloudflare@experimental` ### How to develop in the repository From 376219a3063c9c47c9e7f31a503a52ff93ed38aa Mon Sep 17 00:00:00 2001 From: Dario Piotrowicz Date: Fri, 1 Nov 2024 09:55:12 +0000 Subject: [PATCH 3/3] better align prereleases section with that of the aws package --- README.md | 27 ++++++++++++++------------- 1 file changed, 14 insertions(+), 13 deletions(-) diff --git a/README.md b/README.md index 876b6185..4bb09516 100644 --- a/README.md +++ b/README.md @@ -21,19 +21,20 @@ The repository contains two directories: 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@experimental` +#### 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/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, 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/cloudflare@main +``` ### How to develop in the repository