Skip to content

Commit

Permalink
docs: Mention CI
Browse files Browse the repository at this point in the history
  • Loading branch information
zcbenz committed Apr 3, 2024
1 parent f744c4f commit 4c21bba
Showing 1 changed file with 16 additions and 0 deletions.
16 changes: 16 additions & 0 deletions docs/architecture.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

0 comments on commit 4c21bba

Please sign in to comment.