diff --git a/.github/workflows/e2e-tests.yml b/.github/workflows/e2e-tests.yml index b8a1a978e..a14c41cfd 100644 --- a/.github/workflows/e2e-tests.yml +++ b/.github/workflows/e2e-tests.yml @@ -8,7 +8,9 @@ on: env: WASP_TELEMETRY_DISABLE: 1 - WASP_VERSION: 0.20.0 + WASP_VERSION: + # If you're copying this workflow to your own project, set this to your app's Wasp version: + main jobs: test: @@ -27,9 +29,16 @@ jobs: - name: Docker setup uses: docker/setup-buildx-action@v3 - - name: Install Wasp + - name: Install Wasp ${{ env.WASP_VERSION }} + if: env.WASP_VERSION != 'main' run: curl -sSL https://get.wasp.sh/installer.sh | sh -s -- -v ${{ env.WASP_VERSION }} + # If you're copying this workflow to your own project, you can remove this step: + - name: Install latest development Wasp + if: env.WASP_VERSION == 'main' + # Installs the latest published build of the CLI from the `main` branch. + run: npm i -g https://pkg.pr.new/@wasp.sh/wasp-cli@main + - name: Cache global node modules uses: actions/cache@v4 with: diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index d82128c9c..d6bde10d6 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -17,6 +17,10 @@ Repo is divided into two main parts: [template](/template) dir and [opensaas-sh] ## How to Contribute +> [!IMPORTANT] +> The in-development version of the template uses the in-development version of Wasp. We've set up the `./tools/wasp` script. +> To use it, whenever you would normally run `wasp `, run `/tools/wasp ` instead. + 1. Make sure you understand the basics of how open-saas works (check out [docs](https://docs.opensaas.sh)). 2. Check out this repo (`main` branch) and make sure you are able to get the app in [template/app/](/template/app) running (to set it up, follow the same steps as for running a new open-saas app, as explained in the open-saas docs). 3. Create a new git branch for your work (aka feature branch) and do your changes on it. diff --git a/opensaas-sh/README.md b/opensaas-sh/README.md index 87ba05df8..7fb6b61f3 100644 --- a/opensaas-sh/README.md +++ b/opensaas-sh/README.md @@ -10,6 +10,10 @@ Inception :)! ### Demo app (app_diff/) +> [!IMPORTANT] +> The in-development version of the template uses the in-development version of Wasp. We've set up the `./tools/wasp` script. +> To use it, whenever you would normally run `wasp `, run `/tools/wasp ` instead. + Since the demo app is just the open saas template with some small tweaks, and we want to be able to easily keep it up to date as the template changes, we don't version (in git) the actual demo app code, instead we version the diffs between it and the template: `app_diff/`. #### Workflow diff --git a/tools/wasp b/tools/wasp new file mode 100755 index 000000000..12fd61186 --- /dev/null +++ b/tools/wasp @@ -0,0 +1,5 @@ +#!/bin/sh + +# Just a wrapper to always use the latest Wasp CLI from main branch. + +npx -y https://pkg.pr.new/@wasp.sh/wasp-cli@main "$@"