Ekhlass/Flutter_Documentation · Datasets at Hugging Face

text stringlengths 1 474
<topic_start>Build and release an iOS app
This guide provides a step-by-step walkthrough of releasing a
Flutter app to the App Store and TestFlight.<topic_end>
<topic_start>
Preliminaries
Xcode is required to build and release your app. You
must use a device running macOS to follow this guide.Before beginning the process of releasing your app,
ensure that it meets Apple’s App Review Guidelines.To publish your app to the App Store,
you must first enroll in the Apple Developer Program.
You can read more about the various membership options in Apple’s
Choosing a Membership guide.<topic_end>
<topic_start>
Video overview
For those who prefer video over text,
the following video covers the same material as this guide.Release an iOS app with Flutter in 7 steps<topic_end>
<topic_start>
Register your app on App Store Connect
Manage your app’s life cycle on
App Store Connect (formerly iTunes Connect).
You define your app name and description, add screenshots,
set pricing, and manage releases to the App Store and TestFlight.Registering your app involves two steps: registering a unique
Bundle ID, and creating an application record on App Store Connect.For a detailed overview of App Store Connect, see the
App Store Connect guide.<topic_end>
<topic_start>
Register a Bundle ID
Every iOS application is associated with a Bundle ID,
a unique identifier registered with Apple.
To register a Bundle ID for your app, follow these steps:<topic_end>
<topic_start>
Create an application record on App Store Connect
Register your app on App Store Connect:For a detailed overview, see
Add an app to your account.<topic_end>
<topic_start>
Review Xcode project settings
This step covers reviewing the most important settings
in the Xcode workspace.
For detailed procedures and descriptions, see
Prepare for app distribution.Navigate to your target’s settings in Xcode:Verify the most important settings.In the Identity section of the General tab:In the Signing & Capabilities tab:In the Deployment section of the Build Settings tab:The General tab of your project settings should resemble
the following:For a detailed overview of app signing, see
Create, export, and delete signing certificates.<topic_end>
<topic_start>
Updating the app’s deployment version
If you changed Deployment Target in your Xcode project,
open ios/Flutter/AppframeworkInfo.plist in your Flutter app
and update the MinimumOSVersion value to match.<topic_end>
<topic_start>
Add an app icon
When a new Flutter app is created, a placeholder icon set is created.
This step covers replacing these placeholder icons with your
app’s icons:<topic_end>
<topic_start>
Add a launch image
Similar to the app icon,
you can also replace the placeholder launch image:<topic_end>
<topic_start>
Create a build archive and upload to App Store Connect
During development, you’ve been building, debugging, and testing
with debug builds. When you’re ready to ship your app to users
on the App Store or TestFlight, you need to prepare a release build.<topic_end>
<topic_start>
Update the app’s build and version numbers
The default version number of the app is 1.0.0.
To update it, navigate to the pubspec.yaml file
and update the following line:The version number is three numbers separated by dots,
such as 1.0.0 in the example above, followed by an optional
build number such as 1 in the example above, separated by a +.Both the version and the build number can be overridden in
flutter build ipa by specifying --build-name and --build-number,
respectively.In iOS, build-name uses CFBundleShortVersionString
while build-number uses CFBundleVersion.
Read more about iOS versioning at Core Foundation Keys
on the Apple Developer’s site.You can also override the pubspec.yaml build name and number in Xcode:<topic_end>
<topic_start>
Create an app bundle
Run flutter build ipa to produce an Xcode build archive (.xcarchive file)
in your project’s build/ios/archive/ directory and an App Store app
bundle (.ipa file) in build/ios/ipa.Consider adding the --obfuscate and --split-debug-info flags to
obfuscate your Dart code to make it more difficult
to reverse engineer.If you are not distributing to the App Store, you can optionally
choose a different export method by
adding the option --export-method ad-hoc,
--export-method development or --export-method enterprise.info Note
On versions of Flutter where flutter build ipa --export-method is unavailable,
open build/ios/archive/MyApp.xcarchive and follow the instructions below
to validate and distribute the app from Xcode.<topic_end>
<topic_start>
Upload the app bundle to App Store Connect
Once the app bundle is created, upload it to
App Store Connect by either:Install and open the Apple Transport macOS app.
Drag and drop the build/ios/ipa/*.ipa app bundle into the app.Or upload the app bundle from the command line by running:Run man altool for details about how to authenticate with the App Store Connect API key.Or open build/ios/archive/MyApp.xcarchive in Xcode.Click the Validate App button. If any issues are reported,
address them and produce another build. You can reuse the same
build ID until you upload an archive.After the archive has been successfully validated, click
Distribute App.info Note
When you export your app at the end of Distribute App,
Xcode will create a directory containing
an IPA of your app and an ExportOptions.plist file.
You can create new IPAs with the same options without launching
Xcode by running
flutter build ipa --export-options-plist=path/to/ExportOptions.plist.
See xcodebuild -h for details about the keys in this property list.You can follow the status of your build in the
Activities tab of your app’s details page on

<topic_start>Build and release an iOS app

This guide provides a step-by-step walkthrough of releasing a

Flutter app to the App Store and TestFlight.<topic_end>

<topic_start>

Preliminaries

Xcode is required to build and release your app. You

must use a device running macOS to follow this guide.Before beginning the process of releasing your app,

ensure that it meets Apple’s App Review Guidelines.To publish your app to the App Store,

you must first enroll in the Apple Developer Program.

You can read more about the various membership options in Apple’s

Choosing a Membership guide.<topic_end>

<topic_start>

Video overview

For those who prefer video over text,

the following video covers the same material as this guide.Release an iOS app with Flutter in 7 steps<topic_end>

<topic_start>

Register your app on App Store Connect

Manage your app’s life cycle on

App Store Connect (formerly iTunes Connect).

You define your app name and description, add screenshots,

set pricing, and manage releases to the App Store and TestFlight.Registering your app involves two steps: registering a unique

Bundle ID, and creating an application record on App Store Connect.For a detailed overview of App Store Connect, see the

App Store Connect guide.<topic_end>

<topic_start>

Register a Bundle ID

Every iOS application is associated with a Bundle ID,

a unique identifier registered with Apple.

To register a Bundle ID for your app, follow these steps:<topic_end>

<topic_start>

Create an application record on App Store Connect

Register your app on App Store Connect:For a detailed overview, see

Add an app to your account.<topic_end>

<topic_start>

Review Xcode project settings

This step covers reviewing the most important settings

in the Xcode workspace.

For detailed procedures and descriptions, see

Prepare for app distribution.Navigate to your target’s settings in Xcode:Verify the most important settings.In the Identity section of the General tab:In the Signing & Capabilities tab:In the Deployment section of the Build Settings tab:The General tab of your project settings should resemble

the following:For a detailed overview of app signing, see

Create, export, and delete signing certificates.<topic_end>

<topic_start>

Updating the app’s deployment version

If you changed Deployment Target in your Xcode project,

open ios/Flutter/AppframeworkInfo.plist in your Flutter app

and update the MinimumOSVersion value to match.<topic_end>

<topic_start>

Add an app icon

When a new Flutter app is created, a placeholder icon set is created.

This step covers replacing these placeholder icons with your

app’s icons:<topic_end>

<topic_start>

Add a launch image

Similar to the app icon,

you can also replace the placeholder launch image:<topic_end>

<topic_start>

Create a build archive and upload to App Store Connect

During development, you’ve been building, debugging, and testing

with debug builds. When you’re ready to ship your app to users

on the App Store or TestFlight, you need to prepare a release build.<topic_end>

<topic_start>

Update the app’s build and version numbers

The default version number of the app is 1.0.0.

To update it, navigate to the pubspec.yaml file

and update the following line:The version number is three numbers separated by dots,

such as 1.0.0 in the example above, followed by an optional

build number such as 1 in the example above, separated by a +.Both the version and the build number can be overridden in

flutter build ipa by specifying --build-name and --build-number,

respectively.In iOS, build-name uses CFBundleShortVersionString

while build-number uses CFBundleVersion.

Read more about iOS versioning at Core Foundation Keys

on the Apple Developer’s site.You can also override the pubspec.yaml build name and number in Xcode:<topic_end>

<topic_start>

Create an app bundle

Run flutter build ipa to produce an Xcode build archive (.xcarchive file)

in your project’s build/ios/archive/ directory and an App Store app

bundle (.ipa file) in build/ios/ipa.Consider adding the --obfuscate and --split-debug-info flags to

obfuscate your Dart code to make it more difficult

to reverse engineer.If you are not distributing to the App Store, you can optionally

choose a different export method by

adding the option --export-method ad-hoc,

--export-method development or --export-method enterprise.info Note

On versions of Flutter where flutter build ipa --export-method is unavailable,

open build/ios/archive/MyApp.xcarchive and follow the instructions below

to validate and distribute the app from Xcode.<topic_end>

<topic_start>

Upload the app bundle to App Store Connect

Once the app bundle is created, upload it to

App Store Connect by either:Install and open the Apple Transport macOS app.

Drag and drop the build/ios/ipa/*.ipa app bundle into the app.Or upload the app bundle from the command line by running:Run man altool for details about how to authenticate with the App Store Connect API key.Or open build/ios/archive/MyApp.xcarchive in Xcode.Click the Validate App button. If any issues are reported,

address them and produce another build. You can reuse the same

build ID until you upload an archive.After the archive has been successfully validated, click

Distribute App.info Note

When you export your app at the end of Distribute App,

Xcode will create a directory containing

an IPA of your app and an ExportOptions.plist file.

You can create new IPAs with the same options without launching

Xcode by running

flutter build ipa --export-options-plist=path/to/ExportOptions.plist.

See xcodebuild -h for details about the keys in this property list.You can follow the status of your build in the

Activities tab of your app’s details page on