Skip to content

docs: Set up the app before the stores and add xcodeVersion to scloud.yaml - #929

Open
Crazelu wants to merge 2 commits into
mainfrom
docs/app-publishing-setup-first
Open

Crazelu wants to merge 2 commits into
mainfrom
docs/app-publishing-setup-first

Conversation

@Crazelu

@Crazelu Crazelu commented Nov 17, 2026

Copy link
Copy Markdown
Collaborator

Brings the App publishing docs in line with two serverpod_cloud changes.

  • App setup before the stores: the console's store guides now wait for app setup to save the app identifier (serverpod/serverpod_cloud#3229). The App publishing page now covers app setup before connecting the stores, and explains that each guide waits for the command and then shows the identifier to enter in the store.
  • project.app.xcodeVersion: the CLI now reads the Xcode version for iOS builds from scloud.yaml (serverpod/serverpod_cloud#3217). The scloud.yaml schema page now lists it, and says to quote the value, because YAML reads an unquoted 26.10 as 26.1.

@Crazelu
Crazelu requested a review from a team November 17, 2026 22:12
@Crazelu Crazelu self-assigned this Nov 17, 2026
Comment on lines +51 to +54
Each store's setup guide starts after `app setup` has saved the app identifier for that platform. Until then, the guide shows the `app setup` command to run, and it continues by itself when the command is done. The guide then shows your bundle ID or package name, which you enter in the store, and walks you through the steps:

- **App Store:** Join the Apple Developer Program, register your app's bundle ID, create the app in App Store Connect, and add an App Store Connect API key. Only the project owner can add the key.
- **Google Play:** Sign up for Play Console, create the app with your app's package name, choose an upload key, and invite Serverpod Cloud's service account to your app in Play Console. Serverpod Cloud can create the upload key for you, or you can upload the keystore you already sign the app with.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

The guide doesn't continue on its own. The console checks every 5 seconds whether app setup has saved the identifier, then shows "Connected bundle ID …" (or package name) and enables a Continue button that the reader selects (setup_sheet.dart and app_setup_blocker.dart, from serverpod/serverpod_cloud#3229).

With app setup now first on the page, a reader who follows it in order never sees that waiting screen, so it fits in a note after the steps:

Suggested change
Each store's setup guide starts after `app setup` has saved the app identifier for that platform. Until then, the guide shows the `app setup` command to run, and it continues by itself when the command is done. The guide then shows your bundle ID or package name, which you enter in the store, and walks you through the steps:
- **App Store:** Join the Apple Developer Program, register your app's bundle ID, create the app in App Store Connect, and add an App Store Connect API key. Only the project owner can add the key.
- **Google Play:** Sign up for Play Console, create the app with your app's package name, choose an upload key, and invite Serverpod Cloud's service account to your app in Play Console. Serverpod Cloud can create the upload key for you, or you can upload the keystore you already sign the app with.
Each store's setup guide shows your bundle ID or package name, which you enter in the store, and walks you through the steps:
- **App Store:** Join the Apple Developer Program, register your app's bundle ID, create the app in App Store Connect, and add an App Store Connect API key. Only the project owner can add the key.
- **Google Play:** Sign up for Play Console, create the app with your app's package name, choose an upload key, and invite Serverpod Cloud's service account to your app in Play Console. Serverpod Cloud can create the upload key for you, or you can upload the keystore you already sign the app with.
:::note
If you open a guide before running `app setup`, the guide shows the command to run. When the command is done, it shows the connected bundle ID or package name. Select **Continue** to open the steps.
:::


**Type:** string. **Optional.**

The Xcode version to build your iOS app with, such as `26.6`. When unset, iOS builds use the Xcode version that Serverpod Cloud selects. Android builds ignore this setting. Put the version in quotes: without them, YAML reads a version such as `26.10` as the number `26.1`.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Suggestion: The style guide's section 8 (updated in #931) keeps colons for bold lead-ins and for sentences that introduce a list, table, or code block. This one joins two clauses, so "because" fits better:

Suggested change
The Xcode version to build your iOS app with, such as `26.6`. When unset, iOS builds use the Xcode version that Serverpod Cloud selects. Android builds ignore this setting. Put the version in quotes: without them, YAML reads a version such as `26.10` as the number `26.1`.
The Xcode version to build your iOS app with, such as `26.6`. When unset, iOS builds use the Xcode version that Serverpod Cloud selects. Android builds ignore this setting. Put the version in quotes, because YAML reads an unquoted version such as `26.10` as the number `26.1`.


#### xcodeVersion

**Type:** string. **Optional.**

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Nit: The CLI also accepts a number here (YamlUnion({String, double}) in scloud_config_io.dart, with the note "Unquoted, a version like 27.2 is a YAML number"). The quoting advice below already steers readers to a string, so the type line can match the code:

Suggested change
**Type:** string. **Optional.**
**Type:** string or number. **Optional.**

This branch has not been deployed

No deployments
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.

2 participants