Skip to content

Commit db3898e

Browse files
committed
Updated readme regarding desktop bundles
1 parent 55af029 commit db3898e

File tree

2 files changed

+21
-4
lines changed

2 files changed

+21
-4
lines changed

.github/workflows/linux.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ jobs:
2727
uses: Swatinem/rust-cache@v2
2828

2929
- name: Install development dependencies
30-
run: sudo apt-get install -y libgtk-3-dev libjavascriptcoregtk-4.1-dev libsoup-3.0-dev libwebkit2gtk-4.1-dev libxdo-dev
30+
run: sudo apt-get install -y build-essential libgtk-3-dev libjavascriptcoregtk-4.1-dev libsoup-3.0-dev libwebkit2gtk-4.1-dev libxdo-dev
3131

3232
- name: Install Bun
3333
uses: oven-sh/setup-bun@v1
@@ -63,7 +63,7 @@ jobs:
6363
cp icons/[email protected] dist/resources/[email protected]
6464
6565
- name: Build
66-
run: mv Cargo.toml Cargo.toml.bak && cp Cargo.desktop.toml Cargo.toml && WEBKIT_DISABLE_COMPOSITING_MODE=1 dx bundle --platform desktop --release
66+
run: mv Cargo.toml Cargo.toml.bak && cp Cargo.desktop.toml Cargo.toml && WEBKIT_DISABLE_COMPOSITING_MODE=1 dx bundle --platform desktop --release --package deb
6767

6868
- name: Upload artifact
6969
uses: actions/upload-artifact@v4

README.md

Lines changed: 19 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -150,6 +150,17 @@ strip = true
150150
incremental = false
151151
```
152152

153+
- If you want to use Github Actions to deploy the app you should add the following secrets in the repository settings:
154+
155+
```text
156+
API_URL (for the web app) -> update this after your API deployment
157+
APP_URL (for the API) -> update this after your web deployment
158+
SUPABASE_URL
159+
SUPABASE_API_KEY
160+
SUPABASE_JWT_SECRET
161+
DATABASE_URL
162+
```
163+
153164
### API
154165

155166
- Install the `flyctl` CLI using `curl -L https://fly.io/install.sh | sh` and login with your [Fly.io account](https://fly.io) using `fly auth login`.
@@ -159,7 +170,13 @@ incremental = false
159170

160171
### Web
161172

162-
- To deploy the web app using Github Pages you have to add the following secrets in the repository settings: `API_URL`, `SUPABASE_URL`, `SUPABASE_API_KEY`, `SUPABASE_JWT_SECRET`, `DATABASE_URL`. In the pages settings choose the `gh-pages` branch. You should also set workflow permissions under the actions settings to `Read and write permissions`.
173+
- To deploy the web app using Github Pages you have to choose in the repository settings under Pages the `gh-pages` branch. You should also set workflow permissions under the Actions settings to `Read and write permissions`.
163174
- Change the `base_path` in the `Dioxus.pages.toml` file to match the name of your repository.
164175
- Remember to deploy your api with `APP_URL` set to your Github Pages domain (e.g. `https://albbus-stack.github.io`) otherwise there will be CORS errors.
165-
- Configure the `.github/workflows/web.yaml` file to deploy on every push to the `main` branch or manually with the `workflow_dispatch` event.
176+
- Configure the `.github/workflows/deploy-web.yaml` workflow to deploy on every push to the `main` branch or manually with the `workflow_dispatch` event.
177+
178+
### Desktop
179+
180+
> Github actions for the Windows, Linux and MacOS platforms are not yet functioning since `dx bundle` fails with various errors.
181+
182+
- Currently `dx bundle` is being actively developed and is not yet ready for production use, so you should use `dx build` if bundling fails (this is not good since you need attach the `dist` folder to your release to include your assets).

0 commit comments

Comments
 (0)