Skip to content

Commit 0cdc733

Browse files
committed
docs: document module build cache cleanup
1 parent cd26999 commit 0cdc733

11 files changed

Lines changed: 91 additions & 19 deletions

File tree

AGENTS.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ and sourced reasoning; mine them for *why*, but pick the next task from
1818
`ROADMAP.md`.
1919

2020
1. [`PROJECT_CONTEXT.md`](PROJECT_CONTEXT.md) — single-page consolidated
21-
project context. Pins the load-bearing invariants, current v1.8.245
21+
project context. Pins the load-bearing invariants, current v1.8.246
2222
stack, the module layout, roadmap-file routing, and current source-of-truth
2323
state.
2424
2. [`ARCHITECTURE.md`](ARCHITECTURE.md) — contributor-facing module,
@@ -92,7 +92,7 @@ not as a file list or test log.
9292

9393
`gradle.properties` `projectVersionCode` + `projectVersionName` bump in lockstep
9494
with the changelog commit. Tag the release commit at the same time
95-
(`git push --tags`). HEAD is `v1.8.245` (versionCode 2045) as of 2026-06-04.
95+
(`git push --tags`). HEAD is `v1.8.246` (versionCode 2046) as of 2026-06-04.
9696

9797
### 5. Definition of Done (per [ROADMAP.md](ROADMAP.md) §15)
9898

ARCHITECTURE.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# SwiftFloris Architecture
22

3-
Last updated: 2026-06-04, against the v1.8.245 codebase.
3+
Last updated: 2026-06-04, against the v1.8.246 codebase.
44

55
This file is the fast architectural map for contributors. It is intentionally
66
shorter than `ROADMAP.md` and more code-oriented than `PROJECT_CONTEXT.md`.
@@ -182,6 +182,9 @@ output out of committed history.
182182
Fastlane changelog drafting guidance keeps the short store-facing release text
183183
within the 480-character draft budget before the metadata script enforces the
184184
hard limit.
185+
Repo hygiene also documents that `git rm --cached` does not delete ignored
186+
`lib/<module>/build/` caches, so generated module output stays local unless a
187+
small textual summary is committed under `docs/`.
185188

186189
The local VM used by some agent runs may not have Java or the Android SDK on
187190
PATH. In that case, record the exact Gradle command attempted and leave final

CHANGELOG.md

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,41 @@
22

33
All SwiftFloris release history is consolidated here. This replaces the former root-level `RELEASE_NOTES_v*.md` file-per-release pattern.
44

5+
<a id="v1.8.246"></a>
6+
## v1.8.246
7+
8+
Released: 2026-06-04
9+
10+
### Module build-cache cleanup guidance
11+
12+
O1 is closed. Repo hygiene now documents that `git rm --cached` removes tracked generated files from the index but does not delete ignored local `lib/<module>/build/` caches, so contributors know to treat those directories as local output rather than release evidence.
13+
14+
### Changes
15+
16+
- **`docs/REPO_HYGIENE.md`** - adds a module build-cache survival note under the generated-output rule, with explicit index-vs-local-cache expectations and safe cleanup guidance.
17+
- **`ROADMAP.md` / `COMPLETED.md` / `RESEARCH_REPORT.md` / `README.md` / `PROJECT_CONTEXT.md` / `AGENTS.md` / `ARCHITECTURE.md` / `gradle.properties` / fastlane metadata** - advances the release marker to v1.8.246 / versionCode 2046 and closes O1.
18+
19+
### Verification
20+
21+
- `git diff --check` - PASS.
22+
- `bash scripts/check-fastlane-metadata.sh` - PASS for versionCode 2046.
23+
- `bash scripts/check-repo-hygiene.sh` - PASS.
24+
- APK assembly was intentionally skipped in this local docs-only batch per operator request to avoid repeated heavy Android builds.
25+
26+
### Files Touched
27+
28+
- `AGENTS.md`
29+
- `ARCHITECTURE.md`
30+
- `CHANGELOG.md`
31+
- `COMPLETED.md`
32+
- `PROJECT_CONTEXT.md`
33+
- `README.md`
34+
- `RESEARCH_REPORT.md`
35+
- `ROADMAP.md`
36+
- `docs/REPO_HYGIENE.md`
37+
- `fastlane/metadata/android/en-US/changelogs/2046.txt` (new)
38+
- `gradle.properties` (versionCode 2045->2046, versionName 1.8.245->1.8.246)
39+
540
<a id="v1.8.245"></a>
641
## v1.8.245
742

COMPLETED.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -84,6 +84,7 @@ Consolidated from the archived open-work checklist (closed items). Full per-rele
8484
- [x] WS12 (P2) — Localization content-quality pass cleared Turkish adjacent repeated-word lint with native-safe copy, tightened source labels, standardized trust-sensitive failure/destructive wording, and documented translation-safe cleanup rules. Shipped v1.8.243. — *Source: docs/archive/TODO_2026-06-03.md A5 / improvement-plan WS12.*
8585
- [x] WS10 / WS15 (P2) — Visual-QA, manual-QA, and release-evidence checklists now live in `docs/QA_CHECKLISTS.md` and are linked from verification, contributor, accessibility, and README docs. Shipped v1.8.244. — *Source: docs/archive/TODO_2026-06-03.md A5 / improvement-plan WS10/WS15.*
8686
- [x] R5 (P3) — Fastlane changelog drafting guidance now documents the 480-character draft budget, store-facing summary rules, and evidence-backed wording expectations. Shipped v1.8.245. — *Source: docs/archive/TODO_2026-06-03.md A5 / second-pass R5.*
87+
- [x] O1 (P3) — Repo hygiene now documents that `lib/<module>/build/` generated caches can survive `git rm --cached` and must be treated as local ignored output, not review evidence. Shipped v1.8.246. — *Source: docs/archive/TODO_2026-06-03.md A5 / second-pass O1.*
8788
- [x] F1, F2, F15, F16, F17, F19, F20, F25, F26, F32, F34, F35, F36, F41, F42, EI8, EI11, EI4 (doc) — Closed across v1.8.174 -> v1.8.187. — *Source: TODO_2026-06-03.md*
8889
- [x] IMPROVEMENT_PLAN Workstreams 1, 3, 4, 5, 6 complete; Workstream 2 (lint) monotonically decreasing. — *Source: IMPROVEMENT_PLAN_2026-05-18.md*
8990

PROJECT_CONTEXT.md

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
**Maintained at root for fast onboarding.**
44
**Last consolidated:** 2026-06-04 (from the autonomous research run at
55
[`.ai/research/2026-05-17/`](.ai/research/2026-05-17/) plus follow-up slices
6-
through v1.8.245).
6+
through v1.8.246).
77

88
This file is the single fastest read for an AI session, new contributor, or
99
maintainer-context refresh. It does **not** replace [ROADMAP.md](ROADMAP.md),
@@ -47,7 +47,7 @@ them requires changing both the relevant code *and* the gate.
4747
If a proposed change conflicts with any of these, the answer is "move that
4848
feature into an addon" — never "loosen the invariant."
4949

50-
## 3. Stack at HEAD (v1.8.245)
50+
## 3. Stack at HEAD (v1.8.246)
5151

5252
```
5353
Kotlin 2.3.21 · Compose BOM 2026.05.01 · Material 3 + material-kolor 4.1.1
@@ -204,7 +204,7 @@ and in [`ROADMAP.md` §0 v5.5 + v5.4](ROADMAP.md). Net deltas to invariants:
204204
at `docs/outreach/2026-05-17-swiftkey-migration/` covering
205205
AlternativeTo, BGR, Android Authority, and r/Swiftkey.
206206

207-
**v1.8.104 - v1.8.245** ships the seventh research-pass privacy,
207+
**v1.8.104 - v1.8.246** ships the seventh research-pass privacy,
208208
voice, clipboard, NLP, visual-regression, Addons trust/asset/catalog layer, and
209209
input-behavior testability plus conservative lint/dependency cleanup and
210210
performance-baseline / CI-quality / repo-hygiene / destructive-confirmation
@@ -538,7 +538,7 @@ keyboard preview field now renders as a distinct bottom surface, exposes
538538
ready/active focus-state feedback, preserves bottom-bar traversal ordering, and
539539
uses coroutine-safe feedback when Android cannot open the keyboard picker.
540540

541-
v1.8.171 through v1.8.245 refresh the release front door after the 2026-05-31
541+
v1.8.171 through v1.8.246 refresh the release front door after the 2026-05-31
542542
SwiftKey account-export cutoff, consolidate planning into `ROADMAP.md`,
543543
backfill audit docs, ship settings search and search polish, add hardware
544544
keyboard import and per-app language/accent discovery, harden release gates
@@ -622,6 +622,10 @@ v1.8.245 closes the Fastlane changelog drafting gap: repo hygiene, local
622622
verification, contributor, architecture, and agent-facing release docs now
623623
describe the 480-character draft budget, store-facing summary focus, and
624624
evidence-backed wording rule for each versionCode changelog.
625+
v1.8.246 closes the module build-cache hygiene gap: `docs/REPO_HYGIENE.md`
626+
now explains that `git rm --cached` untracks generated `lib/<module>/build/`
627+
entries without deleting the ignored local cache directory, and that such
628+
cache contents should not be preserved as review evidence.
625629

626630
## 4. Module layout
627631

README.md

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# SwiftFloris
22

3-
![Version](https://img.shields.io/badge/version-v1.8.245-blue) ![License](https://img.shields.io/badge/license-Apache%202.0-green) ![Platform](https://img.shields.io/badge/platform-Android%208.0+-orange) ![Network](https://img.shields.io/badge/network-none-lightgrey) ![Dictionary imports](https://img.shields.io/badge/dictionary%20imports-local%20files-green)
3+
![Version](https://img.shields.io/badge/version-v1.8.246-blue) ![License](https://img.shields.io/badge/license-Apache%202.0-green) ![Platform](https://img.shields.io/badge/platform-Android%208.0+-orange) ![Network](https://img.shields.io/badge/network-none-lightgrey) ![Dictionary imports](https://img.shields.io/badge/dictionary%20imports-local%20files-green)
44

55
**SwiftFloris** is a privacy-first Android keyboard, forked from FlorisBoard and pushed toward SwiftKey-class multilingual typing without the cloud. It ships under Apache-2.0, holds no `INTERNET` permission, and binds zero accounts.
66

@@ -37,7 +37,7 @@
3737
3838
## Highlights
3939

40-
| Area | What's in v1.8.245 | Privacy posture |
40+
| Area | What's in v1.8.246 | Privacy posture |
4141
|------|-------------------|-----------------|
4242
| **Autocorrect / prediction** | SCOWL 117k English dictionary, SymSpell d1+d2, bigram + trigram next-word, capitalization-aware completions, contraction handling, instant-remember user-dictionary overlay | On-device |
4343
| **Multilingual typing** | Bilingual subtype presets (EN+ES / EN+FR / EN+DE), per-token Latin language identification, top-two straddle guard, sentence-local context scoring, and opt-in remembered keyboard language per app | On-device |
@@ -56,7 +56,7 @@
5656
| **Editor reliability** | Expected-content generation for selection, text commit, composing finalize, and composing-region replacement paths now happens before `InputConnection` batch edits, with try/finally begin/end pairing and focused call-order tests | Local editor state only |
5757
| **Alternative layouts** | Colemak / Dvorak / Workman from the FlorisBoard layout pack, plus selectable honeycomb hex layout with clipped hex keys and hex-aware hit testing (only FOSS Android keyboard shipping this — Typewise vacated the consumer market early 2026; see [docs/HONEYCOMB_LAYOUT.md](docs/HONEYCOMB_LAYOUT.md)) | On-device |
5858
| **AI transparency** | First-run AI/ML explainer plus Settings → About → AI features screen covering next-word, glide, voice, translation, and smart compose; async suggestion work consumes request-scoped privacy snapshots for incognito, no-personalized-learning, offensive-content, and ghost-text sensitivity gates | On-device, no account, no telemetry |
59-
| **CI / build** | No-network gate, repo-hygiene gate, Fastlane changelog drafting guide, OSV dep scan, Dependabot version review, lint baseline-drift wrapper with no committed app lint baseline, startup crash recovery via the local crash dialog, restore/crash diagnostics routed through project logging with safe fallback copy, settings-search resource/route drift guard, MIME helper aggregate-contract tests, NativeStr ByteBuffer slice tests, localization/copy contract tests, post-hotfix regression coverage for Arabic shaping, Snygg imports, private trace suppression, and locale-scoped n-gram flushes, manual emulator settings smoke, reproducible-build toolchain pins + build-twice APK self-check chained into release publication, Roborazzi visual-regression hard gate with committed theme/Addons baselines, Macrobenchmark trace sections in 6 hot paths, manual benchmark trend-regression report, and compatible dependency freshness through Compose BOM 2026.05.01 / KSP 2.3.9 / Roborazzi 1.63.0 | Audit-friendly |
59+
| **CI / build** | No-network gate, repo-hygiene gate with module build-cache cleanup guidance, Fastlane changelog drafting guide, OSV dep scan, Dependabot version review, lint baseline-drift wrapper with no committed app lint baseline, startup crash recovery via the local crash dialog, restore/crash diagnostics routed through project logging with safe fallback copy, settings-search resource/route drift guard, MIME helper aggregate-contract tests, NativeStr ByteBuffer slice tests, localization/copy contract tests, post-hotfix regression coverage for Arabic shaping, Snygg imports, private trace suppression, and locale-scoped n-gram flushes, manual emulator settings smoke, reproducible-build toolchain pins + build-twice APK self-check chained into release publication, Roborazzi visual-regression hard gate with committed theme/Addons baselines, Macrobenchmark trace sections in 6 hot paths, manual benchmark trend-regression report, and compatible dependency freshness through Compose BOM 2026.05.01 / KSP 2.3.9 / Roborazzi 1.63.0 | Audit-friendly |
6060

6161
## Distribution
6262

@@ -288,6 +288,7 @@ Real device-number collection is tracked in [`docs/BENCHMARKS.md`](docs/BENCHMAR
288288

289289
The full release stream lives in [`CHANGELOG.md`](CHANGELOG.md) and on [GitHub Releases](https://github.com/SysAdminDoc/SwiftFloris/releases).
290290

291+
- **v1.8.246** (2026-06-04) — Repo hygiene now explains that module `build/` caches can survive `git rm --cached` and should be treated as local ignored output. ([notes](CHANGELOG.md#v1.8.246))
291292
- **v1.8.245** (2026-06-04) — Fastlane changelog drafting now documents the 480-character draft budget, store-facing summary rules, and evidence-backed wording expectations. ([notes](CHANGELOG.md#v1.8.245))
292293
- **v1.8.244** (2026-06-04) — Visual-QA, manual-QA, and release-evidence checklists now live in `docs/QA_CHECKLISTS.md` and are linked from verification docs. ([notes](CHANGELOG.md#v1.8.244))
293294
- **v1.8.243** (2026-06-04) — Localization copy now avoids Turkish repeated-word lint, uses clearer source labels, and standardizes trust-sensitive failure/destructive copy with focused resource tests. ([notes](CHANGELOG.md#v1.8.243))
@@ -476,7 +477,7 @@ limitations under the License.
476477

477478
## Status
478479

479-
🚀 **Active development.** Current release: **v1.8.245** (2026-06-04). The SwiftKey account export window closed on **2026-05-31**; local/on-device migration paths remain documented above.
480+
🚀 **Active development.** Current release: **v1.8.246** (2026-06-04). The SwiftKey account export window closed on **2026-05-31**; local/on-device migration paths remain documented above.
480481

481482
---
482483

0 commit comments

Comments
 (0)