wasp-lang/wasp
1
1
Fork 0
mirror of https://github.com/wasp-lang/wasp.git synced 2024-12-18 06:32:05 +03:00
Code Issues Projects Releases Wiki Activity

Added instructions to publish docs on new release.

Browse Source
This commit is contained in:
Martin Šošić 2022-03-01 12:05:45 +01:00 committed by GitHub
parent 0a7a8cdd38
commit 8c3f60a617
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 12 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

23
waspc/README.md
View File

@ -303,19 +303,20 @@ We also wrote a `new-release` script which you can use to help you with creating
NOTE: If building of your commit is suddenly taking much longer time, it might be connected with cache on Github Actions. NOTE: If building of your commit is suddenly taking much longer time, it might be connected with cache on Github Actions.
If it happens just once every so it is probably nothing to worry about. If it happens consistently, we should look into it. If it happens just once every so it is probably nothing to worry about. If it happens consistently, we should look into it.
### Typicall Release Process ### Typical Release Process
- Update ChangeLog.md with release notes and open an PR for feedback - Update ChangeLog.md with release notes and open an PR for feedback.
- After approval, squash and merge PR for ChangeLog.md into `main` - After approval, squash and merge PR for ChangeLog.md into `main`.
- Make sure you are on `main` and up to date locally :D and then run `./new-release 0.x.y.z` - Make sure you are on `main` and up to date locally :D and then run `./new-release 0.x.y.z`.
- This will automatically create a new commit for updating the version in package.yaml, tag it, and push it all - This will automatically create a new commit for updating the version in package.yaml, tag it, and push it all.
- Wait for CI to finish & succeed for the new tag - Wait for CI to finish & succeed for the new tag.
- This will automatically create a new draft release - This will automatically create a new draft release.
- Find new draft release here: https://github.com/wasp-lang/wasp/releases and edit it with your release notes - Find new draft release here: https://github.com/wasp-lang/wasp/releases and edit it with your release notes.
- Publish the draft release when ready - Publish the draft release when ready.
- Announce new release in Discord - Publish new [docs](/web#deployment).
- Announce new release in Discord.
## Documentation ## Documentation
External documentation, for users of Wasp, is hosted in [separate repo](https://wasp-lang.dev/docs/tutorials/getting-started). External documentation, for users of Wasp, is hosted at https://wasp-lang.dev/docs, and its source is available at [web/docs](/web/docs), next to the website and blog.
Make sure to update it when changes modify how Wasp works. Make sure to update it when changes modify how Wasp works.