From f0fb3fe05d73ebf604369c218b7cfe00c65f9f9d Mon Sep 17 00:00:00 2001 From: Davide Grilli Date: Thu, 2 Jul 2026 22:01:33 +0200 Subject: [PATCH] docs: link CHANGELOG.md and require updating it on new version tags MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit CLAUDE.md: add a working rule to update CHANGELOG.md whenever is bumped for a new release tag. README.md: add a Changelog section pointing to it, and fix a stale claim that release signing "is not set up yet" for Android — it now is, via docker/build.sh android and the persistent keystore (docker/keystore/). --- CLAUDE.md | 1 + README.md | 11 +++++++++-- 2 files changed, 10 insertions(+), 2 deletions(-) diff --git a/CLAUDE.md b/CLAUDE.md index 07b6ac9..67f0d7e 100644 --- a/CLAUDE.md +++ b/CLAUDE.md @@ -84,3 +84,4 @@ Note: a plain `dotnet build` at the solution level needs the Android SDK path fo - **Cross-implementation tests:** compare addresses, txids, and PSBTs against a reference wallet (golden vectors). A different address or txid is a blocking bug. - **Security:** seed and private keys never in plaintext on disk/logs/network; every server response validated with Merkle + checkpoints; watch-only truly read-only. +- **Releases:** whenever a new version tag is created (bumping `` in `src/App/PalladiumWallet.App.csproj`), update `CHANGELOG.md` with an entry for that version before/with the tag — it's the technical record of what shipped, not optional bookkeeping. diff --git a/README.md b/README.md index b4365f8..1e1b89a 100644 --- a/README.md +++ b/README.md @@ -218,8 +218,11 @@ The ABI restriction uses the `AbiArm64Only` flag, which is scoped to the Android command line, it leaks to the `net10.0` projects (`Core`/`App`) and breaks the build. (The legacy `AndroidSupportedAbis` property is deprecated and ignored.) -(Set `ANDROID_HOME` to skip the `-p:AndroidSdkDirectory` flag.) Release signing with your own -keystore is not set up yet; the debug apk is fine for personal sideloading. +(Set `ANDROID_HOME` to skip the `-p:AndroidSdkDirectory` flag.) This debug apk is fine for personal +sideloading, but debug builds are signed with a key regenerated per build machine/container, so a +newer debug apk won't install over an older one without an uninstall first. For a stable signature +across releases (needed to update an existing install in place), build via +`./docker/build.sh android` instead — see [docker/keystore/README.md](docker/keystore/README.md). > **Verification status.** The default multi-ABI apk is verified running on the x86_64 emulator > (UI renders, connects to a server over TLS). The arm64-only apk builds correctly (41 MB, @@ -332,6 +335,10 @@ The default wallet file is `~/.palladium-wallet//wallets/default.wallet --- +## Changelog + +Technical, per-version changes are tracked in [CHANGELOG.md](CHANGELOG.md). + ## License Released under the MIT License. See the [LICENSE](LICENSE) file.