Skip to content

docs: the app configuration of every product - #11

Merged
kengoon merged 2 commits into
mainfrom
docs/app-configuration
Nov 12, 2026
Merged

kengoon merged 2 commits into
mainfrom
docs/app-configuration

Conversation

@kengoon

@kengoon kengoon commented Nov 12, 2026 •

Copy link
Copy Markdown
Contributor

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's pyproject.toml is.

    • The base: GoogleService-Info.plist in include_files, the firebase-ios-sdk Swift package with that product, and OTHER_LDFLAGS = "$(inherited) -ObjC".
    • Then the product's own settings:
    Product Adds
    Auth the callback URL scheme; the GoogleSignIn-iOS and facebook-ios-sdk packages with their URL schemes and Facebook Info.plist keys; the Sign in with Apple, Game Center and keychain-sharing entitlements
    Remote Config RemoteConfigDefaults.plist in include_files
    App Check the App Attest entitlement; FirebaseAppCheckTokenAutoRefreshEnabled
    Analytics, Crashlytics, Performance the collection keys (optional)
    Crashlytics the dSYM upload (kivyforge already makes Release builds with dSYMs)
    Messaging the aps-environment entitlement and UIBackgroundModes
  • Xcode (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

  • What each product adds, linked to each product's section.
  • Every product together in one commented pyproject.toml, with Google Sign-In and Facebook Login. The same as Xcode steps.
  • Entitlements and provisioning profiles, and a link to the tested e2e configuration.

Notes

  • Entitlements use kivyforge's [tool.kivy.ios.entitlements]. I checked that kivyforge supports it.
  • kivyforge manages DEBUG_INFORMATION_FORMAT itself (dwarf-with-dsym for Release) and refuses it in build_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-symbols tool. The Xcode tab uses the run script.

Checks

  • Every TOML block on the site parses with 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 old DEBUG_INFORMATION_FORMAT line with the reviewer's ConfigError.
  • Long lines were wrapped so the code boxes don't overflow.
  • mkdocs build --strict is clean, with links and anchors checked.

🤖 Generated with Claude Code

- 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>

@jetbrains-air jetbrains-air Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for this, Kenechukwu! One blocking inline comment needs addressing before this can merge.

Comment thread docs/crashlytics/index.md Outdated
[tool.kivy.ios.xcode.build_settings]
OTHER_LDFLAGS = "$(inherited) -ObjC"
# readable stack traces
DEBUG_INFORMATION_FORMAT = "dwarf-with-dsym"

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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>

@jetbrains-air jetbrains-air Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for the quick fix, Kenechukwu, this is approved and good to merge!

@kengoon
kengoon merged commit e83ee34 into main Nov 12, 2026
4 checks passed
@kengoon
kengoon deleted the docs/app-configuration branch November 12, 2026 07:43
@kengoon kengoon mentioned this pull request Nov 12, 2026
kengoon added a commit that referenced this pull request Nov 12, 2026
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>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant