Repository navigation
docs(store): Myket & Iranian-store publishing prep - #97
ErfanBagheri404 wants to merge 13 commits into
Conversation
… icon, screenshots, CI unsigned-APK gate [skip ci] [skip release]
Reviewer's GuidePrepares Controlix for Myket and other Iranian Android store publishing by documenting compliance and submission metadata, adding the required icon and screenshots, and hardening release CI so unsigned or missing APKs fail instead of being published. Flow diagram for the signed APK publishing gateflowchart TD
A[Build release APK] --> B{Release APK exists}
B -->|No| C[Fail job: no release APK produced]
B -->|Yes| D{APK filename contains unsigned}
D -->|Yes| E[Fail job: unsigned release APK]
D -->|No| F[Accept signed APK]
F --> G[Collect APK for release]
File-Level Changes
Tips and commandsInteracting with Sourcery
Customizing Your ExperienceAccess your dashboard to:
Getting Help
|
|
Important
This repository does not receive automatic reviews because it has fewer than 10 stars.
|
…skip ci] [skip release]
There was a problem hiding this comment.
Hey - I've found 8 issues
Prompt for AI Agents
Please address the comments from this code review:
## Individual Comments
### Comment 1
<location path="docs/PRIVACY-POLICY.md" line_range="95" />
<code_context>
+Because no data leaves your device, retention is entirely under your control:
+**uninstalling the app deletes everything.** Every remote, macro, pin and
+setting is stored in the app's private directory and is removed by Android on
+uninstall. There is no cloud backup of your data anywhere.
+
+## Children
</code_context>
<issue_to_address>
**Saved data survives uninstall**
When android backup is enabled and the user has stored app data, android Auto Backup includes eligible databases, preferences, and the automation broadcast token because the manifest enables backups without exclusions. Saved data can leave the device and remain recoverable after uninstall, and anyone who gains access to the backup can access the token, contradicting the policy's promises.
Disable backup and exclude app data, or revise the policy to disclose what can be backed up and recovered.
Also at `docs/store/README.md:48-49`, `docs/PRIVACY-POLICY.md:9-10`, `docs/store/LISTING.md:100-102`.
</issue_to_address>
### Comment 2
<location path=".github/workflows/release.yml" line_range="81" />
<code_context>
+ set -- app/build/outputs/apk/release/*.apk
+ for APK in "$@"; do
+ case "$APK" in
+ *unsigned*)
+ echo "::error::unsigned release APK ($APK) — signing secrets are missing or wrong"
+ exit 1
</code_context>
<issue_to_address>
**Updates use an incompatible signing key**
When the configured keystore is valid but uses a certificate different from the store’s registered signing certificate, the filename-only gate accepts a correctly signed APK even when its certificate differs from the one registered for the package, so the workflow publishes an update that the store rejects.
Verify each APK’s signing certificate against a pinned expected fingerprint before collecting or publishing it.
</issue_to_address>
### Comment 3
<location path="docs/store/README.md" line_range="13-14" />
<code_context>
+| --- | --- |
+| `LISTING.md` | Ready-to-paste Persian + English title, tagline, description, category, contact info, and the panel fields for Myket. |
+| `../PRIVACY-POLICY.md` | Full privacy policy. Publish it somewhere reachable by URL (GitHub Pages, your site, or a GitHub blob link) and paste that URL into Myket's privacy field. |
+| `../img/icon-512.png` | 512x512 store icon, rendered from `docs/img/icon.png` (1024x1024 source). |
+| `screenshots/*.png` | Seven real in-app screenshots, 1344x2992 (Pixel 8 Pro class), captured from the running app on an emulator. Myket requires at least 3. |
+
+## Technical verdict
</code_context>
<issue_to_address>
**Store assets are unavailable**
When a maintainer checks out this PR to prepare the store upload, the documented `../img/icon-512.png` and `screenshots/*.png` files are absent, so maintainers cannot retrieve the icon or required screenshots for submission.
Add the assets at the documented paths or change the documentation to point to existing files.
Also at `docs/store/LISTING.md:35`.
</issue_to_address>
### Comment 4
<location path="docs/store/LISTING.md" line_range="35" />
<code_context>
+| App title (fa + en) | required | `Controlix` | PASS |
+| App icon | square, high quality, no copyright marks, no excessive text | adaptive icon, 1024×1024 foreground, themed, monochrome layer for Android 13 themed icons | PASS |
+| Descriptions (fa + en) | required | below | PASS |
+| Screenshots | **at least 3, from inside the app** | must be captured | ACTION |
+| Package name | reserved, unique | `com.erfanbagheri.controlix` | PASS |
+| Age rating | required | 3+ (no violence, no social content) | PASS |
</code_context>
<issue_to_address>
**Screenshot status is contradictory**
When a publisher consults both store documents, the README says seven screenshots have been captured, while the listing says they still need to be generated; publishers cannot tell whether this step is complete and may repeat it.
Make the screenshot status consistent in both documents.
Also at `docs/store/LISTING.md:43-45`, `docs/store/README.md:14`.
</issue_to_address>
### Comment 5
<location path="docs/store/LISTING.md" line_range="142-143" />
<code_context>
+
+- [ ] Download the signed APK from the GitHub release — **do not** upload an
+ unsigned debug build.
+- [ ] Sign the APK with the production keystore (`keytool -list -v -keystore ...`).
+- [ ] `zipalign -p -v 4 in.apk out.apk` and verify with `apksigner verify`.
+- [ ] Confirm `targetSdkVersion` is 34+ in the merged manifest.
+- [ ] Screenshots taken from inside the app (≥3, 1080×1920 or larger).
</code_context>
<issue_to_address>
**Release checklist produces invalid APKs**
When someone follows the release checklist to prepare an APK for upload, `keytool -list` only inspects a keystore; it does not sign the APK. Aligning an APK after signing also invalidates its signature, so following these steps does not produce the verified signed artifact the store requires.
Give the correct sequence: run `zipalign` first, sign with `apksigner sign`, then verify that same output with `apksigner verify`.
</issue_to_address>
### Comment 6
<location path="docs/PRIVACY-POLICY.md" line_range="87-88" />
<code_context>
+
+## Third-party services
+
+None. Controlix has no third-party services, SDKs, servers or APIs of any
+kind. There is no one we could share data with even if we wanted to.
+
+## Data retention and deletion
</code_context>
<issue_to_address>
**Policy denies bundled SDKs**
The policy says there are no third-party SDKs of any kind, but the app includes ZXing and JourneyApps’ embedded ZXing library for QR scanning. Readers are given an inaccurate account of the app’s dependencies.
Clarify that the app has no third-party SDKs that collect or transmit user data, while disclosing its local QR-scanning libraries.
</issue_to_address>
### Comment 7
<location path="docs/PRIVACY-POLICY.md" line_range="32-33" />
<code_context>
+- **No crash logs.** Nothing reports crashes back to us. If the app crashes,
+ only you see it.
+- **No network access whatsoever in the published build.** The release manifest
+ declares only `android.permission.TRANSMIT_IR` and
+ `android.permission.CAMERA`. There is no `INTERNET` permission, so the
+ operating system itself blocks any outbound connection.
+
</code_context>
<issue_to_address>
**Generated permission omitted from disclosures**
When the AndroidX merged manifest includes the generated permission, the store materials say the release manifest declares only `TRANSMIT_IR` and `CAMERA`, but the publishing checklist itself notes the generated `DYNAMIC_RECEIVER_NOT_EXPORTED_PERMISSION`. A merged-manifest permission audit therefore does not match the materials’ stated permission list.
Make the permission disclosures consistently distinguish the two functional permissions from the generated signature permission.
Also at `docs/store/LISTING.md:26`.
</issue_to_address>
### Comment 8
<location path="docs/store/LISTING.md" line_range="4" />
<code_context>
+# Controlix — Store listing (Myket, Cafe Bazar, other Iranian stores)
+
+Prepared for: Myket Publishing Rules of 15 October 2026, checked against
+<https://myket.ir/kb/pages/...>.
+
+---
</code_context>
<issue_to_address>
**Myket rules link is a placeholder**
When a reader follows the Myket source link in the listing, the cited `/kb/pages/...` URL does not identify a specific Myket rules page, so readers following this reference cannot reach the cited publishing rules from the listing.
Replace the placeholder with the specific Myket rules URL used in the README.
</issue_to_address>Sourcery assessment
Approval pending. 4 findings to address first.
Blocking findings: docs/PRIVACY-POLICY.md:95, .github/workflows/release.yml:81, docs/store/README.md:14, docs/store/LISTING.md:143
| Because no data leaves your device, retention is entirely under your control: | ||
| **uninstalling the app deletes everything.** Every remote, macro, pin and | ||
| setting is stored in the app's private directory and is removed by Android on | ||
| uninstall. There is no cloud backup of your data anywhere. |
There was a problem hiding this comment.
🟠 High · Saved data survives uninstall
When android backup is enabled and the user has stored app data, android Auto Backup includes eligible databases, preferences, and the automation broadcast token because the manifest enables backups without exclusions. Saved data can leave the device and remain recoverable after uninstall, and anyone who gains access to the backup can access the token, contradicting the policy's promises.
Disable backup and exclude app data, or revise the policy to disclose what can be backed up and recovered.
Also at docs/store/README.md:48-49, docs/PRIVACY-POLICY.md:9-10, docs/store/LISTING.md:100-102.
Prompt for AI agents
In `docs/PRIVACY-POLICY.md` at line 95:
**Saved data survives uninstall**
When android backup is enabled and the user has stored app data, android Auto Backup includes eligible databases, preferences, and the automation broadcast token because the manifest enables backups without exclusions. Saved data can leave the device and remain recoverable after uninstall, and anyone who gains access to the backup can access the token, contradicting the policy's promises.
Disable backup and exclude app data, or revise the policy to disclose what can be backed up and recovered.
Also at `docs/store/README.md:48-49`, `docs/PRIVACY-POLICY.md:9-10`, `docs/store/LISTING.md:100-102`.| set -- app/build/outputs/apk/release/*.apk | ||
| for APK in "$@"; do | ||
| case "$APK" in | ||
| *unsigned*) |
There was a problem hiding this comment.
🟡 Medium · Updates use an incompatible signing key
When the configured keystore is valid but uses a certificate different from the store’s registered signing certificate, the filename-only gate accepts a correctly signed APK even when its certificate differs from the one registered for the package, so the workflow publishes an update that the store rejects.
Verify each APK’s signing certificate against a pinned expected fingerprint before collecting or publishing it.
Prompt for AI agents
In `.github/workflows/release.yml` at line 81:
**Updates use an incompatible signing key**
When the configured keystore is valid but uses a certificate different from the store’s registered signing certificate, the filename-only gate accepts a correctly signed APK even when its certificate differs from the one registered for the package, so the workflow publishes an update that the store rejects.
Verify each APK’s signing certificate against a pinned expected fingerprint before collecting or publishing it.| | App title (fa + en) | required | `Controlix` | PASS | | ||
| | App icon | square, high quality, no copyright marks, no excessive text | adaptive icon, 1024×1024 foreground, themed, monochrome layer for Android 13 themed icons | PASS | | ||
| | Descriptions (fa + en) | required | below | PASS | | ||
| | Screenshots | **at least 3, from inside the app** | must be captured | ACTION | |
There was a problem hiding this comment.
⚪ Low · Screenshot status is contradictory
When a publisher consults both store documents, the README says seven screenshots have been captured, while the listing says they still need to be generated; publishers cannot tell whether this step is complete and may repeat it.
Make the screenshot status consistent in both documents.
Also at docs/store/LISTING.md:43-45, docs/store/README.md:14.
Prompt for AI agents
In `docs/store/LISTING.md` at line 35:
**Screenshot status is contradictory**
When a publisher consults both store documents, the README says seven screenshots have been captured, while the listing says they still need to be generated; publishers cannot tell whether this step is complete and may repeat it.
Make the screenshot status consistent in both documents.
Also at `docs/store/LISTING.md:43-45`, `docs/store/README.md:14`.| - [ ] Sign the APK with the production keystore (`keytool -list -v -keystore ...`). | ||
| - [ ] `zipalign -p -v 4 in.apk out.apk` and verify with `apksigner verify`. |
There was a problem hiding this comment.
🟡 Medium · Release checklist produces invalid APKs
When someone follows the release checklist to prepare an APK for upload, keytool -list only inspects a keystore; it does not sign the APK. Aligning an APK after signing also invalidates its signature, so following these steps does not produce the verified signed artifact the store requires.
Give the correct sequence: run zipalign first, sign with apksigner sign, then verify that same output with apksigner verify.
Prompt for AI agents
In `docs/store/LISTING.md` at lines 142-143:
**Release checklist produces invalid APKs**
When someone follows the release checklist to prepare an APK for upload, `keytool -list` only inspects a keystore; it does not sign the APK. Aligning an APK after signing also invalidates its signature, so following these steps does not produce the verified signed artifact the store requires.
Give the correct sequence: run `zipalign` first, sign with `apksigner sign`, then verify that same output with `apksigner verify`.| None. Controlix has no third-party services, SDKs, servers or APIs of any | ||
| kind. There is no one we could share data with even if we wanted to. |
There was a problem hiding this comment.
⚪ Low · Policy denies bundled SDKs
The policy says there are no third-party SDKs of any kind, but the app includes ZXing and JourneyApps’ embedded ZXing library for QR scanning. Readers are given an inaccurate account of the app’s dependencies.
Clarify that the app has no third-party SDKs that collect or transmit user data, while disclosing its local QR-scanning libraries.
Prompt for AI agents
In `docs/PRIVACY-POLICY.md` at lines 87-88:
**Policy denies bundled SDKs**
The policy says there are no third-party SDKs of any kind, but the app includes ZXing and JourneyApps’ embedded ZXing library for QR scanning. Readers are given an inaccurate account of the app’s dependencies.
Clarify that the app has no third-party SDKs that collect or transmit user data, while disclosing its local QR-scanning libraries.| declares only `android.permission.TRANSMIT_IR` and | ||
| `android.permission.CAMERA`. There is no `INTERNET` permission, so the |
There was a problem hiding this comment.
⚪ Low · Generated permission omitted from disclosures
When the AndroidX merged manifest includes the generated permission, the store materials say the release manifest declares only TRANSMIT_IR and CAMERA, but the publishing checklist itself notes the generated DYNAMIC_RECEIVER_NOT_EXPORTED_PERMISSION. A merged-manifest permission audit therefore does not match the materials’ stated permission list.
Make the permission disclosures consistently distinguish the two functional permissions from the generated signature permission.
Also at docs/store/LISTING.md:26.
Prompt for AI agents
In `docs/PRIVACY-POLICY.md` at lines 32-33:
**Generated permission omitted from disclosures**
When the AndroidX merged manifest includes the generated permission, the store materials say the release manifest declares only `TRANSMIT_IR` and `CAMERA`, but the publishing checklist itself notes the generated `DYNAMIC_RECEIVER_NOT_EXPORTED_PERMISSION`. A merged-manifest permission audit therefore does not match the materials’ stated permission list.
Make the permission disclosures consistently distinguish the two functional permissions from the generated signature permission.
Also at `docs/store/LISTING.md:26`.| # Controlix — Store listing (Myket, Cafe Bazar, other Iranian stores) | ||
|
|
||
| Prepared for: Myket Publishing Rules of 15 October 2026, checked against | ||
| <https://myket.ir/kb/pages/...>. |
There was a problem hiding this comment.
⚪ Low · Myket rules link is a placeholder
When a reader follows the Myket source link in the listing, the cited /kb/pages/... URL does not identify a specific Myket rules page, so readers following this reference cannot reach the cited publishing rules from the listing.
Replace the placeholder with the specific Myket rules URL used in the README.
Prompt for AI agents
In `docs/store/LISTING.md` at line 4:
**Myket rules link is a placeholder**
When a reader follows the Myket source link in the listing, the cited `/kb/pages/...` URL does not identify a specific Myket rules page, so readers following this reference cannot reach the cited publishing rules from the listing.
Replace the placeholder with the specific Myket rules URL used in the README.Sourcery withdrew this approval because the latest commits introduced blocking findings.
…bservable Language switch flipped chrome to RTL then reverted to LTR until a cold restart: the wrapped context sets the direction on creation, but every later configuration delivery (insets, font scale, the recreate() after the switch) carries the *system* locale, reverting Compose to LTR. Pin LocalLayoutDirection in the theme from isFa()/languageState() instead of trusting the framework config, and make the chosen language Compose-observable so the theme re-derives typography and direction in place. Drop screenLayout from configChanges so layout-category deliveries recreate instead of silently overwriting the direction.
A single DevicePad screen scavenges each remote's own button labels into family-shaped rows (power, temp, mode, speed, oscillate, timer, light/color/effects for lighting, volume/input/sound modes for audio, d-pad/source for projectors, cleaning for vacuums), so fans, soundbars, projectors, light strips and the rest no longer fall back to the TV channel pad. AC keeps its stateful AcPadScreen.
The pads read as flat lists of grey words: every control was the same
visual weight, 22 fan mode keys stacked under one heading, and the
shortcuts ("More keys") repeated for Soundbar and Projector.
- KeyGrid/KeyTile: real key tiles (surface, hairline stroke, 56dp
min touch, press tint) laid out two-per-row for LARGE primary keys
and three-per-row for SMALL supporting ones, with padding for the
same touch floor as the TV pad.
- PadKeySize on PadRow: primary rows (speed, temp, oscillate, timer,
light, humidity, brightness, colors, effects, playback, input,
sound modes, cleaning) step up to LARGE; supporting rows stay SMALL.
- Group compound mode keys by their head word (Heat/Vent/Dry/HeatDry)
via ButtonNames.modeHead, each group its own heading, so a fan's
22 chips split into four scannable rows instead of one wall.
- DPad becomes a round cluster: four directional keys around centre
OK at full touch size, absent directions shown as a mute dot.
- Keypad gets its own heading (appliance_keypad) so it no longer
collides with the shortcuts row's heading.
- KeyGrid indexes by chunk position rather than indexOf(key), which
would mis-resolve when two remotes share identical code labels.
Admiral_AC.ir supports one mode, so the mode row showed a single live control and four greyed-out ones — a dead strip sitting above every usable key. Omit unsupported presets from the row; the footnote below it still lists what's missing, so the information stays visible without presenting unpressable controls.
Appliance, AC, fan, soundbar, projector, lighting, cleaning and
air-treatment pads now mirror the TV pad (ui/Pad.kt): same header row
(back 26dp + bordered capsule + EmitPulse + 8dp accent dot + name +
44dp spacer), surfaceVariant 20dp-radius tiles, 1dp outline dividers,
and the same pressable feedback. Render layer split out of DevicePad.kt
into DevicePadScreen.kt, StepperRow.kt, DPad.kt and KeyGrid.kt so each
file stays under the tool-call size limit.
Data layer (sectionsFor) prunes unusable controls and substitutes what
each device needs: +/− and Up/Down pairs become one rocker, modes group
by head (Heat/Vent/Dry/Heatdry), power pairs into a toggle, rockers
replace chip walls. Stepper rows carry their own label and no heading,
so six soundbar rockers no longer print twelve blocks. Single-key rows
fill the line; two split it.
Fixes along the way: snake_case labels no longer leak (KeyGrid),
duplicate headings fold into one row, navigation chips no longer repeat
the d-pad heading, duplicate Source/Input keys dedupe by visible label,
RTL digit-led labels ("5m") get an LTR isolate so they stop reading
"m5" in Farsi, and the bare Mode key reads as "Cycle" instead of
"Mode / Mode".
ui/Pad.kt (TV pad) is untouched.
[skip ci] [skip release]
- prettyKey: strip every leading Source/Input word so "SOURCE INPUT A" and "INPUT A" collapse to one tile; a bare short token gets "Input" back so the row reads "Input A" instead of a lone "A". - Dedupe by lowercased pretty label — "SOURCE VIDEO"/"INPUT VIDEO" differed only in case and both survived. - StepperRow renders its label through prettyKey, so the soundbar rockers read "Surround Volume", "Surround Balance", "Subwoofer", "A/V Delay" instead of the DB's Surr_Vol/Subwf/AVDelay. - KEY_WORDS: humididier -> Humidifier (DB typo shipped to the pad). - Digit-led tiles force LTR so "5m" stops rendering as "m5" in Farsi. [skip ci] [skip release]
…p ci] [skip release] - DevicePad.kt: leftovers row capped at 8 (PadOverflow.split) with an OVERFLOW row carrying the tail. - DevicePadScreen.kt: OVERFLOW row renders a single ... +N tile that opens ExtraKeysSheet; no heading, so it reads like Mi Remote's trailing cell. - KeyGrid.kt: OverflowTile composable (+N count). - ui/ExtraKeysSheet.kt: Material3 bottom sheet grid (same tiles, same styling) listing the hidden keys. - data/PadOverflow.kt + PadOverflowTest.kt (4 tests, 4 passed). - strings.xml/values-fa: appliance_extra_keys + appliance_extra_keys_hint. - docs: Obsidian 07 - Device Families/Appliance Pad Composition.md. Mi Remote study: study grouping only (no codes). Rejected hero/status card because Controlix is transmit-only and has no real state to show.
What's in this PR
Store-publishing preparation for Myket and the other Iranian Android stores.
1. Publishing requirements — verdict: PASS
signingConfigs.releasereadsKEYSTORE_FILE/KEYSTORE_PASSWORD/KEY_ALIAS/KEY_PASSWORD, all four present as Actions secretsTRANSMIT_IR+CAMERA(both core)2. CI gate (the one code change)
release.ymlsilently produced an unsigned APK if the signing secrets were absent — that file is unpublishable on every store. Added a hard gate that fails the job instead:This is the only workflow change. No app/Gradle source touched.
3. Store assets
docs/PRIVACY-POLICY.md— zero-collection policy (no INTERNET permission, so technically incapable of transmitting)docs/store/LISTING.md— ready-to-paste Farsi + English title, tagline, description, category, contact infodocs/store/README.md— checklist, technical verdict, remaining manual stepsdocs/img/icon-512.png— 512×512 store icondocs/store/screenshots/*.png— 7 real in-app screenshots, 1344×2992 (Myket requires ≥ 3)Remaining manual steps (documented in
docs/store/README.md)No application code, UI, resources or Gradle dependencies changed.
Summary by Sourcery
Prepare the app for broader appliance remote control and Iranian store publishing with honest device-specific pads, improved localization behavior, and release-artifact safeguards.
New Features:
Bug Fixes:
Enhancements:
CI:
Documentation: