diff --git a/docs/architecture.md b/docs/architecture.md index 7b01534..9d111ef 100644 --- a/docs/architecture.md +++ b/docs/architecture.md @@ -31,3 +31,19 @@ may happen, you should test your app with this command before publishing it. Finally there is `npm run dist`, which just runs `npm run build` and then create a ZIP archive. + +## Releasing + +The GitHub Actions workflow in this project relies on CI for releasing. To +publish a new release, push a tag and a new release will be created in the +Releases page. + +In order to make a difference between the development version and the release +version, local builds generated by `npm run build` always have version +`v0.0.1-dev`, and uses the `assets/build/icon-dev` image as icon. While the +release version uses the tag name as version string, and uses the +`assets/build/icon` image as icon. + +As the final note, all the architecture above only applies inside this project, +there is no limitation on how you can use Yue in your project, this boilerplate +means to help you bootstrap a new app quickly.