Skip to content

docs: align README with signed preview release #27

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
turin-dev merged 2 commits into from
Sep 13, 2026
Merged

docs: align README with signed preview release #27

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
ec2e2dd
docs: align README with signed preview release
turin-dev Sep 13, 2026
7809616
docs: restore deploy status row
turin-dev Sep 13, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 13 additions & 7 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,9 +32,10 @@ call the relay's MCP endpoint.
> [!CAUTION]
> GitHub releases `v0.2.0` through `v0.5.0` contain the legacy Shizuku-based
> application. They are not compatible release artifacts for this rewrite.
> A signed, real-device-verified rewrite APK has not been published yet. Until
> one is available, build the Android app from this checkout; see
> [Release channels](docs/RELEASES.md) for the versioning boundary and gates.
> A signed rewrite preview is available as `agent-v0.1.0`, but it has not yet
> passed the real-device stable-release gates. Use it only for controlled
> testing; see [Release channels](docs/RELEASES.md) for the exact acceptance
> boundary and promotion gates.

## Why rewrite

Expand Down Expand Up @@ -69,7 +70,7 @@ Wear OS performance, server code quality, no official version endpoint).
| Low-spec hybrid connection + FCM wake | ⛔ blocked — needs a Firebase project (see `docs/DESIGN.md` §7) |
| Docker packaging for the Go binaries | ✅ `server/Dockerfile` (`--target relay` / `--target publicserver`) |
| docker-compose / reverse-proxy deploy config | ✅ `docker-compose.yml` (Traefik/Dokploy) |
| Signed rewrite APK release | ⛔ not published — legacy releases are incompatible |
| Signed rewrite APK | 🧪 `agent-v0.1.0` preview published — stable promotion pending real-device gates |

## Components

Expand Down Expand Up @@ -115,9 +116,14 @@ docker run --rm -v "$PWD/app:/work" -w /work rishmcp-android-build \
# output: app/app/build/outputs/apk/debug/app-debug.apk
```

The rewrite does not yet have a supported release-signing command. Do not
publish the debug APK as an official release; the acceptance and signing gates
are documented in [`docs/RELEASES.md`](docs/RELEASES.md).
Official signed rewrite APKs are built by the tag-driven
[Android release workflow](.github/workflows/release.yml) from strict
`agent-vMAJOR.MINOR.PATCH` tags. The workflow verifies tag/version metadata,
builds and tests the release APK, signs it with the repository's official
key, verifies the signature, publishes a SHA-256 checksum, and creates a
GitHub **prerelease**. Do not promote that prerelease to stable until the
real-device acceptance gates in [`docs/RELEASES.md`](docs/RELEASES.md) are
recorded.

## Deploy

Expand Down