Require native Git runtime and bundle full manpages
- Remove the app fallback path when native Git is unavailable and show a startup blocker instead - Fix native level setup for staged file counting and cherry-pick parity - Improve manpage loading/search and bundle full Git documentation assets - Integrate Git cross-compilation into AndroidProjectTooling.sh and remove debug AAB support
This commit is contained in:
33
README.md
33
README.md
@@ -11,7 +11,7 @@ The app is organized around GitHug parity rather than simplified command quizzes
|
||||
- Each level file documents the intended repository setup, evaluation strategy, hints, command suggestions, and embedded solution scenarios.
|
||||
- Validators prefer repository state and Git objects over raw command text. Direct command-answer validation is reserved for upstream answer-style levels such as identifying a hash, filename, remote URL, author, or count.
|
||||
- Shared tests execute the embedded solution scenarios for every level and assert that the Android catalog still matches the upstream level order.
|
||||
- The runtime prepares an isolated sandbox per level. When a bundled native Git binary is present, Git commands run against real repository directories; otherwise the Kotlin fallback engine keeps development and tests deterministic.
|
||||
- The runtime prepares an isolated sandbox per level and requires a bundled native Git binary for the device ABI. If no native Git binary is available, the app shows an unavailable-build message instead of starting a playable session.
|
||||
|
||||
The UI supports a terminal-centered workflow with optional inspection panes:
|
||||
|
||||
@@ -46,7 +46,6 @@ Available commands:
|
||||
| `bash ./AndroidProjectTooling.sh` | Provision or refresh the local Android/JDK toolchain only. | Toolchain under `./jdk` and `./android-sdk` |
|
||||
| `bash ./AndroidProjectTooling.sh --test` | Compile host Git, set `GITHUG_TEST_GIT_BINARY`, and run JVM unit tests. | Test reports under `app/build/reports/` |
|
||||
| `bash ./AndroidProjectTooling.sh --build` | Build the debug APK. | `app/build/outputs/apk/debug/githug-android-debug.apk` |
|
||||
| `bash ./AndroidProjectTooling.sh --build-aab` | Build the debug Android App Bundle. | `app/build/outputs/bundle/debug/githug-android-debug.aab` |
|
||||
| `bash ./AndroidProjectTooling.sh --build-release-aab` | Build the release Android App Bundle. | `app/build/outputs/bundle/release/githug-android-release.aab` |
|
||||
| `bash ./AndroidProjectTooling.sh --compile-git` | Compile Git for the development host and all Android target ABIs. | Host and Android `libgit.so` binaries |
|
||||
|
||||
@@ -60,7 +59,6 @@ To build installable/debuggable artifacts:
|
||||
|
||||
```bash
|
||||
bash ./AndroidProjectTooling.sh --build
|
||||
bash ./AndroidProjectTooling.sh --build-aab
|
||||
```
|
||||
|
||||
To build the release AAB intended for Play Store style distribution work:
|
||||
@@ -77,34 +75,33 @@ To avoid repeated expensive SDK verification, the script writes a small state fi
|
||||
|
||||
If all required components were verified successfully, the script will skip SDK verification/reinstallation for the next **24 hours** unless required directories are missing.
|
||||
|
||||
When `--build`, `--build-aab`, or `--build-release-aab` is used, the script also:
|
||||
When `--build` or `--build-release-aab` is used, the script also:
|
||||
|
||||
- increments `versionCode` by 1
|
||||
- increments the patch component of `versionName`, for example `0.1.0` to `0.1.1`
|
||||
- bundles full Git manpage source files from Git's `Documentation/` directory into app assets
|
||||
- renames the generated artifact to a stable `githug-android-*` filename
|
||||
- attempts to create a git commit after a successful build if there are source changes
|
||||
|
||||
The build commands currently run these Gradle tasks:
|
||||
|
||||
- `--build`: `assembleDebug`
|
||||
- `--build-aab`: `bundleDebug`
|
||||
- `--build-release-aab`: `bundleRelease`
|
||||
|
||||
## Git Binary Compilation
|
||||
|
||||
Native Git is compiled with:
|
||||
Native Git compilation is integrated into the root tooling script:
|
||||
|
||||
```bash
|
||||
bash ./CompileGitForAllTargetPlatforms.sh [--host | --android | --all]
|
||||
bash ./AndroidProjectTooling.sh --compile-git
|
||||
```
|
||||
|
||||
Options:
|
||||
|
||||
| Command | Purpose | Output |
|
||||
| --- | --- | --- |
|
||||
| `bash ./CompileGitForAllTargetPlatforms.sh --host` | Compile Git for the development machine. | `build/host-git/libgit.so` |
|
||||
| `bash ./CompileGitForAllTargetPlatforms.sh --android` | Cross-compile Git for Android ABIs served by Google Play. | `app/src/main/jniLibs/<abi>/libgit.so` |
|
||||
| `bash ./CompileGitForAllTargetPlatforms.sh --all` | Compile both host and Android targets. This is the default. | Host and Android outputs |
|
||||
| `bash ./AndroidProjectTooling.sh --test` | Compile Git for the development machine, then run tests with it. | `build/host-git/libgit.so` and test reports |
|
||||
| `bash ./AndroidProjectTooling.sh --compile-git` | Compile host Git and cross-compile Android ABIs served by Google Play. | Host and Android outputs |
|
||||
|
||||
Android ABI outputs:
|
||||
|
||||
@@ -113,22 +110,17 @@ Android ABI outputs:
|
||||
- `app/src/main/jniLibs/x86/libgit.so`
|
||||
- `app/src/main/jniLibs/x86_64/libgit.so`
|
||||
|
||||
The `--test` tooling command automatically runs `CompileGitForAllTargetPlatforms.sh --host` first and exports `GITHUG_TEST_GIT_BINARY=build/host-git/libgit.so`. This keeps JVM tests on the same `GitRepositoryRuntime` path as the app, including the packaged-runtime helper resolution behavior.
|
||||
The `--test` tooling command automatically builds host Git first and exports `GITHUG_TEST_GIT_BINARY=build/host-git/libgit.so`. This keeps JVM tests on the same `GitRepositoryRuntime` path as the app, including the packaged-runtime helper resolution behavior.
|
||||
|
||||
The `--compile-git` tooling command is a convenience wrapper for:
|
||||
|
||||
```bash
|
||||
bash ./CompileGitForAllTargetPlatforms.sh --all
|
||||
```
|
||||
Git manpage assets are also refreshed from the checked-out Git source whenever Git is compiled or an app artifact is built.
|
||||
|
||||
## Runtime Architecture
|
||||
|
||||
The command engine has two execution paths behind one app-facing runtime:
|
||||
The command engine has one app-facing runtime:
|
||||
|
||||
- **Native Git path**: if the packaged executable is present for the device ABI, Git commands execute in a real per-level repository sandbox in app-private storage.
|
||||
- **Kotlin fallback path**: the in-memory sandbox engine mirrors the same observable repository facts for development, JVM tests, and environments without a bundled native Git binary.
|
||||
- **Native Git path**: the packaged executable for the device ABI runs Git commands in a real per-level repository sandbox in app-private storage.
|
||||
|
||||
Both paths expose the same `RepoState` surface to validators. In addition to files, commits, branches, tags, remotes, and config, the model tracks learning-relevant effects such as stashes, fetched remote refs, pushed branches/tags, submodules, and repository maintenance actions.
|
||||
The runtime exposes a `RepoState` surface to validators. In addition to files, commits, branches, tags, remotes, and config, the model tracks learning-relevant effects such as stashes, fetched remote refs, pushed branches/tags, submodules, and repository maintenance actions.
|
||||
|
||||
Helper shell-like commands (`ls`, `pwd`, `cat`, `touch`, `mkdir`, `rm`, `echo`, `cd`) remain implemented in Kotlin so the mobile terminal behaves consistently across devices.
|
||||
|
||||
@@ -149,5 +141,4 @@ Current work is focused on:
|
||||
|
||||
- improving parity with upstream Ruby Githug setup and validation semantics
|
||||
- expanding native-Git-backed behavior across complex repository workflows
|
||||
- preserving robust fallback tests for every level
|
||||
- improving onboarding, accessibility, UI polish, icons, and Play Store readiness
|
||||
|
||||
Reference in New Issue
Block a user