1berry/AFFiNE
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs: clarify and fix desktop build instructions (#12881)

Browse Source 
This PR changes documentation files related to building the desktop
client app to allow other contributors to develop and test without
becoming stuck due to outdated docs.

<!-- This is an auto-generated comment: release notes by coderabbit.ai
-->
## Summary by CodeRabbit

- **Documentation**
- Improved build instructions for native dependencies and E2E testing,
including updated commands and clearer server startup steps.
- Enhanced desktop client app documentation with clarified build steps,
corrected artifact paths, and added Linux installation guidance.
<!-- end of auto-generated comment: release notes by coderabbit.ai -->
This commit is contained in:
Richard Lora 2025-06-23 00:30:41 -04:00 committed by GitHub
parent 76568bae9f
commit e976fcfc04
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
2 changed files with 9 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
docs/BUILDING.md
View File

@ -86,7 +86,7 @@ Run the following script. It will build the native module at [`/packages/fronten
This could take a while if you build it for the first time.
Note: use `strip` from system instead of `binutils` if you are running MacOS. [see problem here](https://github.com/toeverything/AFFiNE/discussions/2840)
```
```sh
yarn affine @affine/native build
```
@ -102,7 +102,8 @@ Adding test cases is strongly encouraged when you contribute new features and bu
We use [Playwright](https://playwright.dev/) for E2E test, and [vitest](https://vitest.dev/) for unit test.
To test locally, please make sure browser binaries are already installed via `npx playwright install`.
Also make sure you have built the `@affine/core` workspace before running E2E tests.
Start server before tests by following [`docs/developing-server.md`](./developing-server.md) first.
### Unit Test
@ -115,6 +116,5 @@ yarn test
```shell
# there are `affine-local`, `affine-migration`, `affine-local`, `affine-prototype` e2e tests,
# which are run under different situations.
cd tests/affine-local
yarn e2e
yarn workspace @affine-test/affine-local e2e
```

6
docs/building-desktop-client-app.md
View File

@ -37,6 +37,8 @@ On Windows, you must enable symbolic links this code repo. See [#### Windows](./
## Build, package & make the desktop client app
> repos/AFFiNE/.github/workflows/release-desktop.yml contains real order to build the desktop client app, but here we will explain the steps in a more detailed way. Up-to date.
### 0. Build the native modules
Please refer to `Build Native Dependencies` section in [BUILDING.md](./BUILDING.md#Build-Native-Dependencies) to build the native modules.
@ -46,6 +48,8 @@ Please refer to `Build Native Dependencies` section in [BUILDING.md](./BUILDING.
On Mac & Linux
```shell
BUILD_TYPE=canary yarn affine @affine/electron build
BUILD_TYPE=canary yarn affine @affine/electron generate-assets
```
@ -110,7 +114,7 @@ Once the build is complete, you can find the paths to the binaries in the termin
```
Finished 2 bundles at:
› Artifacts available at: <affine-repo>/packages/frontend/electron/out/make
› Artifacts available at: <affine-repo>/packages/frontend/apps/electron/out/canary/make
```
## CI