Clarified release instructions in README.md a bit.

wasp-lang · Apr 4, 2024 · 2a4f965 · 2a4f965
1 parent 4c4d48a
commit 2a4f965
Showing 1 changed file with 3 additions and 3 deletions.
diff --git a/waspc/README.md b/waspc/README.md
@@ -400,7 +400,7 @@ If it happens just once every so it is probably nothing to worry about. If it ha
 ### Typical Release Process
 
 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):
   - 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),
     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 that Wasp AI (which is part of `waspc`) is correctly producing apps that work with and use the newest version of Wasp.
-  This usually means checking that templates and prompts are up to date.
+- 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 (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).
   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.