Repository navigation
docs: the app configuration of every product - #11
Conversation
- each product page: an "App configuration" section under Installation, with the kivyforge pyproject.toml lines (GoogleService-Info.plist, the Firebase package with the product, -ObjC, and the product's own entitlements, Info.plist keys and files) and the same as Xcode steps for kivy-ios and Briefcase - Getting started > App configuration: what each product adds, every product together in one example (with Google Sign-In and Facebook Login), entitlements and provisioning profiles, and the tested e2e configuration - Crashlytics with kivyforge: DEBUG_INFORMATION_FORMAT and upload-symbols (kivyforge has no setting for a custom build phase) Every TOML block parses (tomllib). Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
| [tool.kivy.ios.xcode.build_settings] | ||
| OTHER_LDFLAGS = "$(inherited) -ObjC" | ||
| # readable stack traces | ||
| DEBUG_INFORMATION_FORMAT = "dwarf-with-dsym" |
There was a problem hiding this comment.
Blocking: kivyforge won't accept DEBUG_INFORMATION_FORMAT here. It's in kivyforge's RESERVED_BUILD_SETTINGS (kivyforge/config/model.py), and _parse_build_settings raises for it.
Failure scenario: if a user copies this block, or the "Everything together" block (docs/getting-started/configuration.md:71), every kivyforge command stops with ConfigError: [tool.kivy.ios.xcode.build_settings] sets toolchain-reserved key(s): DEBUG_INFORMATION_FORMAT. I ran every kivyforge tab in this PR through load_config_from_text on kivyforge main. These two are the only ones that fail, and both load once the line is removed. A tomllib parse wouldn't catch this.
Suggested fix: remove the line in both places. kivyforge already sets dwarf-with-dsym for Release and dwarf for Debug (platforms/ios/buildsettings.py), so say that instead ("Release builds already produce dSYMs"). Then update the Crashlytics row in the configuration.md table, the PR description, and the upload-symbols note to match: upload the dSYMs from a Release archive.
Produced by Air Automations. Name: Code Review / Run: https://air.jetbrains.cloud/org/a114b0a9-2e82-18ec-abd3-29d0c8a05e2d/automations/c07b9901-fe4e-417d-ae1d-e00c83e39e4c?run=84ce0ce4-b97b-44cb-9408-a77b58883300
There was a problem hiding this comment.
Fixed in f174bbb, thanks. I confirmed it: DEBUG_INFORMATION_FORMAT is in RESERVED_BUILD_SETTINGS, and buildsettings.py sets dwarf-with-dsym for Release and dwarf for Debug.
- The line is gone from the Crashlytics tab and from the "Everything together" block.
- The Crashlytics note now says Release builds already make dSYMs, and to upload the dSYMs of a Release archive with
upload-symbols. - The configuration table row and the PR description are updated.
As you suggested, I also ran every kivyforge tab on the site through load_config_from_text (wrapped in a minimal project): all 14 load. The same check rejects the old line with your ConfigError.
From the review: kivyforge reserves it (RESERVED_BUILD_SETTINGS) and stops with a ConfigError. kivyforge already makes Release builds with dSYMs (dwarf-with-dsym; dwarf for Debug): the Crashlytics note now says so, and to upload the dSYMs of a Release archive with upload-symbols. Every kivyforge tab on the site now loads with kivyforge's own config loader. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Since 0.2.0: - Firestore: in / not-in / array-contains-any value lists, and the query mistakes the SDK would abort the app on, raise ValueError / TypeError (#7, #8) - Messaging: the notification tap that launches a closed Kivy app reaches on_open, with the optional pyios-firebase-notifications-hook package; notifications.launch_hook_status() (#12) - Docs: the app configuration of every product (#11) Co-authored-by: Claude Opus 5.5 <noreply@anthropic.com>
Summary
Every product page in the docs now shows exactly what the app's build needs for that product. A new page puts every product together.
On each product page: "App configuration" (under Installation)
Two tabs:
kivyforge (
pyproject.toml): the lines to add, written the way the e2e app'spyproject.tomlis.GoogleService-Info.plistininclude_files, thefirebase-ios-sdkSwift package with that product, andOTHER_LDFLAGS = "$(inherited) -ObjC".GoogleSignIn-iOSandfacebook-ios-sdkpackages with their URL schemes and FacebookInfo.plistkeys; the Sign in with Apple, Game Center and keychain-sharing entitlementsRemoteConfigDefaults.plistininclude_filesFirebaseAppCheckTokenAutoRefreshEnabledaps-environmententitlement andUIBackgroundModesXcode (kivy-ios, Briefcase): the same setup as numbered Xcode steps: packages, build settings, Info keys, Signing & Capabilities, and the Crashlytics run script.
New page: Getting started → App configuration
pyproject.toml, with Google Sign-In and Facebook Login. The same as Xcode steps.Notes
[tool.kivy.ios.entitlements]. I checked that kivyforge supports it.DEBUG_INFORMATION_FORMATitself (dwarf-with-dsymfor Release) and refuses it inbuild_settings. It also has no setting for a custom build phase. So the Crashlytics kivyforge tab uploads the dSYMs of a Release archive with Crashlytics'upload-symbolstool. The Xcode tab uses the run script.Checks
tomllib, and every kivyforge tab loads with kivyforge's own config loader (load_config_from_text, wrapped in a minimal project). That check rejects the oldDEBUG_INFORMATION_FORMATline with the reviewer'sConfigError.mkdocs build --strictis clean, with links and anchors checked.🤖 Generated with Claude Code