wasp-lang/wasp
1
1
Fork 0
mirror of https://github.com/wasp-lang/wasp.git synced 2024-12-27 02:52:22 +03:00
Code Issues Projects Releases Wiki Activity

Clarified release instructions in README.md a bit.

Browse Source
This commit is contained in:
Martin Šošić 2024-04-04 16:05:28 +02:00 committed by GitHub
parent 4c4d48a81d
commit 2a4f9658b8
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 3 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
waspc/README.md
View File

@ -400,7 +400,7 @@ If it happens just once every so it is probably nothing to worry about. If it ha
### Typical Release Process ### Typical Release Process
Do the steps marked with 👉 for every release of `waspc`. Do the steps marked with 👉 for every release of `waspc`.
Do the non-bold steps when necessary (decide for each step depending on the changes). Do the non-bold steps when necessary (decide for each step depending on the changes, e.g. some can be skipped if there were no breaking changes).
- Update the starter templates if necessary (i.e., if there are breaking changes or new features they should make use of): - Update the starter templates if necessary (i.e., if there are breaking changes or new features they should make use of):
- Context: they are used by used by `wasp new`, you can find reference to them in `Wasp.Cli. ... .StarterTemplates`. - Context: they are used by used by `wasp new`, you can find reference to them in `Wasp.Cli. ... .StarterTemplates`.
@ -409,8 +409,8 @@ Do the non-bold steps when necessary (decide for each step depending on the chan
Update Wasp version in their main.wasp files. Finally, in their repos (for those templates that are on Github), Update Wasp version in their main.wasp files. Finally, in their repos (for those templates that are on Github),
create new git tag that is the same as the new one in `StarterTemplates.hs` (e.g. `wasp-v0.13.1-template`). create new git tag that is the same as the new one in `StarterTemplates.hs` (e.g. `wasp-v0.13.1-template`).
- Make sure apps in [examples](/examples) are up to date and using a version compatible with the newest version of Wasp. - Make sure apps in [examples](/examples) are up to date and using a version compatible with the newest version of Wasp.
- Make sure that Wasp AI (which is part of `waspc`) is correctly producing apps that work with and use the newest version of Wasp. - Make sure that Wasp AI (which is part of `waspc` and you can run it with e.g. `wasp new:ai`) is correctly producing apps that work with and use this newest version of Wasp.
This usually means checking that templates and prompts are up to date. This usually means checking that templates and prompts (e.g. examples of Wasp code) are up to date. If there were no breaking changes, there is likely nothing to be done here.
- Make sure [mage](/mage) is producing Wasp apps that support the newest version of Wasp (this is configured in its Dockerfile: which version of `wasp` CLI will it use to produce app via AI). - Make sure [mage](/mage) is producing Wasp apps that support the newest version of Wasp (this is configured in its Dockerfile: which version of `wasp` CLI will it use to produce app via AI).
Mage itself, as a Wasp app, doesn't have to be using the latest Wasp version to run, but the apps it is producing should. Mage itself, as a Wasp app, doesn't have to be using the latest Wasp version to run, but the apps it is producing should.
- 👉 `ChangeLog.md` and the version in `waspc.cabal` should already be up to date, but double check that they are correct and update them if needed. Also consider enriching and polishing `ChangeLog.md` a bit even if all the data is already there. Also make sure the `ChangeLog.md` specifies the correct version of Wasp. - 👉 `ChangeLog.md` and the version in `waspc.cabal` should already be up to date, but double check that they are correct and update them if needed. Also consider enriching and polishing `ChangeLog.md` a bit even if all the data is already there. Also make sure the `ChangeLog.md` specifies the correct version of Wasp.