chore: release

Author: lencx

.github/workflows/release.yml

@@ -2,8 +2,9 @@ name: Release CI
 
 on:
   push:
-    branches:
-      - release
+    # Sequence of patterns matched against refs/tags
+    tags:
+      - 'v*' # Push events to matching v*, i.e. v1.0, v20.15.10
 
 jobs:
   create-release:
@@ -12,24 +13,22 @@ jobs:
       RELEASE_UPLOAD_ID: ${{ steps.create_release.outputs.id }}
 
     steps:
-      - uses: actions/checkout@v2
-      - name: Setup node
-        uses: actions/setup-node@v1
-        with:
-          node-version: 16
-      - name: Get version
-        run: echo "PACKAGE_VERSION=$(node -p "require('./src-tauri/tauri.conf.json').package.version")" >> $GITHUB_ENV
-      - name: Create release
+      - name: Query version number
+        id: get_version
+        shell: bash
+        run: |
+          echo "using version tag ${GITHUB_REF:10}"
+          echo ::set-output name=version::"${GITHUB_REF:10}"
+
+      - name: Create Release
         id: create_release
         uses: actions/create-release@v1
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
         with:
-          tag_name: v${{ env.PACKAGE_VERSION }}
-          release_name: 'OhMyBox v${{ env.PACKAGE_VERSION }}'
+          tag_name: v${{ steps.get_version.outputs.VERSION }}
+          release_name: 'OhMyBox v${{ steps.get_version.outputs.VERSION }}'
           body: 'See the assets to download this version and install.'
-          draft: true
-          prerelease: false
 
   build-tauri:
     needs: create-release
@@ -41,36 +40,39 @@ jobs:
     runs-on: ${{ matrix.platform }}
     steps:
       - uses: actions/checkout@v2
+
       - name: setup node
         uses: actions/setup-node@v1
         with:
           node-version: 16
+
       - name: install Rust stable
         uses: actions-rs/toolchain@v1
         with:
           toolchain: stable
+
+      - uses: Swatinem/rust-cache@v1
+
       - name: install dependencies (ubuntu only)
         if: matrix.platform == 'ubuntu-latest'
         run: |
           sudo apt-get update
           sudo apt-get install -y libgtk-3-dev webkit2gtk-4.0 libappindicator3-dev librsvg2-dev patchelf
 
-      # Install wasm-pack
+      - name: Install wasm-pack
       - uses: jetli/[email protected]
         with:
           # Optional version of wasm-pack to install(eg. 'v0.9.1', 'latest')
           version: v0.9.1
 
-      # Install rsw
       - name: Install rsw
         run: cargo install rsw
 
-      # Cache
       - name: Get yarn cache directory path
         id: yarn-cache-dir-path
         run: echo "::set-output name=dir::$(yarn config get cacheFolder)"
 
-      - name: Yarn Cache
+      - name: Yarn cache
         uses: actions/cache@v2
         id: yarn-cache # use this to check for `cache-hit` (`steps.yarn-cache.outputs.cache-hit != 'true'`)
         with:
@@ -79,7 +81,6 @@ jobs:
           restore-keys: |
             ${{ runner.os }}-yarn-
 
-      # Install & Build
       - name: Install app dependencies and build it
         run: yarn && yarn build
       - uses: tauri-apps/tauri-action@v0

README.md

@@ -7,6 +7,23 @@
 - [wasm-pack](https://github.com/rustwasm/wasm-pack)
 - [rsw](https://github.com/rwasm/rsw-rs)
 
+### Install wasm-pack
+
+```bash
+cargo install wasm-pack
+
+# With Windows
+cargo install wasm-pack --version 0.9.1
+```
+
+### Install rsw
+
+```bash
+cargo install rsw
+```
+
+**Note: If your operating system is `Windows`, it is recommended to install `wasm-pack v0.9.1`**
+
 ## Quick start
 
 Note: Open two terminal windows, execute `yarn rsw watch` in the first and `yarn tauri dev` in the second. The order of execution is important, do not close the first window!
@@ -18,3 +35,7 @@ yarn rsw watch
 # 2. Front-end: start dev server
 yarn tauri dev
 ```
+
+## License
+
+GPL-3.0 license © 2022 lencx