The codex-daochi-client-mesh-client-rename integration, committed as that task staged it: mesh_client replaces daochi_client, account storage and tests move to the Mesh names, and docs, locales and CI follow, with existing accounts, encrypted records and local storage kept compatible. The task stopped before its dependency versions were pushed; the next commit moves Breeze to the pushed pins it needs. Co-Authored-By: Claude Opus 5.5 <[email protected]>
167 lines
6.8 KiB
Markdown
167 lines
6.8 KiB
Markdown
# Building Inner Breeze
|
|
|
|
The owner may explicitly waive the development Moto check for a particular
|
|
release with `python3 scripts/release.py --phone-check-waiver "owner's authorization"`.
|
|
This records a version- and content-bound waiver, without claiming a passing
|
|
phone test. All other release gates still run.
|
|
|
|
|
|
The build checks Inbe's laws with the Ziran compiler (`ziran check`); no
|
|
separate proof tool is needed. The build host needs Python 3 and the platform's
|
|
native build dependencies. See [build laws](build-laws.md) for the
|
|
checked behavior.
|
|
|
|
Build commands fetch the dependencies pinned in `ziran.lock`.
|
|
|
|
Build and run the desktop app:
|
|
|
|
```bash
|
|
make native
|
|
make run
|
|
```
|
|
|
|
Install the latest published Linux desktop release and keep it current:
|
|
|
|
```bash
|
|
python3 scripts/update-desktop.py --enable-automatic
|
|
```
|
|
|
|
This verifies the release download, installs it under `~/.local`, and checks
|
|
for new releases every 30 minutes and after login. Updates preserve running
|
|
app processes and user data; a running app uses the new version when it is
|
|
next opened. Previous installed files are saved under `backup/desktop-updates/`.
|
|
The user service and timer are named `inner-breeze-update`.
|
|
|
|
Build Android artifacts:
|
|
|
|
```bash
|
|
make android-debug
|
|
PASSWORD=your-keystore-password make android-release
|
|
PASSWORD=your-keystore-password make android-bundle
|
|
```
|
|
|
|
Build the web app:
|
|
|
|
```bash
|
|
make web
|
|
make site
|
|
```
|
|
|
|
Run the test suite:
|
|
|
|
```bash
|
|
make test
|
|
make visual-test
|
|
```
|
|
|
|
CI and releases require the visual gate. It uses disposable profiles and
|
|
private Xvfb displays to check glyph pixels, every zoom from 50% to 250%,
|
|
selected navigation and app cards in all 13 palettes and both color modes,
|
|
enlarged Appearance labels, shipped locales, and page interactions. It keeps
|
|
screenshots and logs under `build/`; CI uploads them even when a check fails.
|
|
Every visual suite runs even if an earlier suite fails. The complete result,
|
|
including hashes of the tested binary and bundles, is in
|
|
`build/visual-test/results.json`; changing an artifact during the gate fails it.
|
|
Its system tools are listed in `.github/apt/test-packages.txt`.
|
|
|
|
Store captures cover Apps, Lumi, Practices, Habits, Lists, Diary, Appearance,
|
|
and supporting pages in phone, 7-inch tablet, 10-inch tablet, and Chromebook
|
|
layouts. Capture runs use disposable profiles on private Xvfb displays and
|
|
check viewport sizes, nonblank rendering, and expected screen text. They do
|
|
not copy images into the store listing until visual review is recorded:
|
|
|
|
```bash
|
|
make native apps PACKAGE_FLAGS=--locked
|
|
make screenshot
|
|
# Inspect build/screenshots/review-*.jpg and the full-size PNGs.
|
|
make screenshot-review REVIEWER="your name"
|
|
make screenshot-export
|
|
make play-preflight
|
|
python3 scripts/upload-play-screenshots.py
|
|
```
|
|
|
|
The scene list in `scripts/screenshot-scenes.json` selects eight store images
|
|
per phone/tablet type while retaining all 64 captures for review. Changing
|
|
source, scene definitions, Kryon, binaries, bundles, or screenshot bytes
|
|
invalidates publishing preflight. A historical capture can still be visually
|
|
reviewed and used for a review video; Play requires a fresh capture of the
|
|
current locked build. Local Kryon preview builds cannot pass Play preflight.
|
|
Preflight checks every dependency against its locked commit and runs a fresh
|
|
source check, so reused incremental preview outputs cannot hide missing imports.
|
|
Keep credentials in the ignored `.env.play` using `.env.play.example`.
|
|
The uploader defaults to validating and discarding its remote edit. After
|
|
review, `PLAY_COMMIT=1 python3 scripts/upload-play-screenshots.py` validates
|
|
and commits the listing; a failed edit is discarded. This updates listing
|
|
assets only. App releases follow the numeric changelog, `update_version.sh`,
|
|
and the existing release workflow, which builds and publishes the signed
|
|
Google Play AAB and owns release tags. A local build or commit is not a Play
|
|
deployment.
|
|
|
|
To test sync and recovery against an isolated local server:
|
|
|
|
```bash
|
|
make sync-server-test MESH_BIN=/absolute/path/to/mesh
|
|
```
|
|
|
|
This uses disposable client databases and a loopback server; see
|
|
[web and sync test coverage](web-testing.md) for details.
|
|
|
|
The Apps picker, independent ZX packages, update settings, account choices and
|
|
publisher setup are described in [app packages](apps.md).
|
|
|
|
Native binaries are written to `build/bin/<platform>/`. Release artifacts are
|
|
written under `build/dist/`.
|
|
|
|
Fixed-commit container builds (`make release-ready` and
|
|
`scripts/phone-install.sh`) reuse `build/release-ready/` and
|
|
`build/release-ready-phone/`, respectively. `RELEASE_READY_OUTPUT` still accepts
|
|
`build/release-ready-NAME`, but names other than `phone` map to
|
|
`build/release-ready/`; read artifacts and stamps from that canonical path.
|
|
The release command uses the same mapping. Task names and versions never
|
|
allocate more output folders. An active output is locked and a second run
|
|
for it stops before changing its files.
|
|
|
|
Both purposes share the existing `build/release-ready/home/`, rather than
|
|
creating a home per output. Keeping this regenerable cache under `build/` also
|
|
keeps the fixed-source overlay from traversing it while recreating source
|
|
directories.
|
|
Ziran keeps sources by repository URL and exact commit under its `.cache/ziran/`,
|
|
so different locks reuse identical dependencies while retaining distinct
|
|
commits. Gradle downloads also reuse this home. Runs hold an exclusive cache
|
|
lease through container exit, including failed builds; different purposes wait
|
|
for that lease. Incremental source-time records and compilation outputs stay
|
|
per purpose. No script prunes existing output or caches, including
|
|
`promo-video` and `package-releases`. Other old per-output homes are not migrated
|
|
or deleted automatically. Normal builds and CI keep their existing cache and
|
|
`build/dist/` paths. Phone signing reuses
|
|
`build/phone-install/app-ABI-debug-signed.apk` (one of the four supported Android
|
|
ABIs) even with a versioned `--apk` input, preserving the default signed path.
|
|
|
|
Dependencies, including Kryon and the Ziran toolchain, are pinned in
|
|
`ziran.lock`. `make` fetches them into the Ziran package cache and links them
|
|
under `build/packages/`; `sh scripts/packages.sh` does the same by hand.
|
|
Builders that supply the sources themselves need no network: put Git checkouts
|
|
containing the locked commits (including Kryon's `raylib` submodule) in
|
|
`$ZIRAN_PACKAGE_SOURCES`, or declare them as F-Droid srclibs, which are found
|
|
in `../srclib` automatically.
|
|
|
|
To debug Inbe against the root Kryon checkout, map it in an ignored
|
|
`ziran.local.toml`:
|
|
|
|
```toml
|
|
[overrides]
|
|
kryon = "../../kryonlabs/kryon"
|
|
```
|
|
|
|
Use this only for local debugging. Permanent Kryon fixes should be committed in
|
|
the root Kryon repository and then brought into Inbe with `ziran update kryon`.
|
|
|
|
## Project Layout
|
|
|
|
- `src/` - app code
|
|
- `assets/` - images, fonts, and sounds
|
|
- `locales/` - translations
|
|
- `droid/` - Android project
|
|
- `site/` - website
|
|
- `ziran.toml`, `ziran.lock` - pinned Ziran toolchain and dependencies
|