Skip to content

Commit b61c3c3

Browse files
[docs] Update documentation to reflect .aab fast deployment support (#10963)
## Summary Updates documentation across multiple files to reflect that fast deployment now works with `.aab` files (Android App Bundles), as implemented in PR #8990. Context: #9455 (comment) ## Changes - **`Documentation/guides/AndroidAssetPacks.md`**: Removed incorrect statement that setting `AndroidPackageFormat` to `aab` disables fast deployment. Added note explaining `.aab` is supported but slower than `.apk` due to `bundletool` processing. - **`Documentation/docs-mobile/building-apps/build-process.md`**: Updated Fast Deployment section to explicitly state support for both `.apk` and `.aab` package formats, with caveat about performance difference. - **`Documentation/docs-mobile/building-apps/build-properties.md`**: Updated `AndroidFastDeploymentType`, `EmbedAssembliesIntoApk`, and `AndroidPackageFormats` property descriptions to reflect `.aab` support. Softened the recommendation against using `aab` for debugging. - **`Documentation/docs-mobile/messages/xa0119.md`**: Removed the "App Bundles" bullet from the list of non-ideal Debug configuration settings, since using `.aab` in Debug is now a valid scenario (e.g., for testing asset packs) with fast deployment support. Co-authored-by: Jonathan Peppers <jonathan.peppers@microsoft.com>
1 parent 018cbc8 commit b61c3c3

File tree

4 files changed

+16
-10
lines changed

4 files changed

+16
-10
lines changed

Documentation/docs-mobile/building-apps/build-process.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -50,8 +50,12 @@ Only the updated assemblies are resynchronized to the target device.
5050
> [!WARNING]
5151
> Fast deployment is known to fail on devices which block `run-as`, which often includes devices older than Android 5.0.
5252
53-
Fast deployment is enabled by default, and may be disabled in Debug builds
53+
Fast deployment is supported for both `.apk` and `.aab` package formats.
54+
It is enabled by default, and may be disabled in Debug builds
5455
by setting the `$(EmbedAssembliesIntoApk)` property to `True`.
56+
Note that using `.aab` with fast deployment will be slower than `.apk`
57+
because the `.aab` file must be processed through `bundletool` for
58+
packaging and installation.
5559

5660
The [Enhanced Fast Deployment](build-properties.md#androidfastdeploymenttype) mode can
5761
be used in conjunction with this feature to speed up deployments even further.

Documentation/docs-mobile/building-apps/build-properties.md

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -553,9 +553,9 @@ of values to control what types can be deployed to the
553553
on the target device
554554
when the [`$(EmbedAssembliesIntoApk)`](#embedassembliesintoapk) MSBuild
555555
property is `False`. If a resource is fast deployed, it is *not*
556-
embedded into the generated `.apk`, which can speed up deployment
556+
embedded into the generated `.apk` or `.aab`, which can speed up deployment
557557
times. (The more that is fast deployed, then the less frequently
558-
the `.apk` needs to be rebuilt, and the install process can be
558+
the package needs to be rebuilt, and the install process can be
559559
faster.) Valid values include:
560560

561561
- `Assemblies`: Deploy application assemblies.
@@ -1042,7 +1042,8 @@ being generated. Setting `AndroidPackageFormats` to either `aab`
10421042
or `apk` will generate only one file.
10431043

10441044
The default value is `aab;apk` for `Release` builds only.
1045-
It is recommended that you continue to use just `apk` for debugging.
1045+
Using `apk` for debugging is faster, but `aab` is also supported
1046+
with fast deployment if needed (for example, when testing asset packs).
10461047

10471048
## AndroidPackageNamingPolicy
10481049

@@ -1639,7 +1640,7 @@ Deployment doesn't support the target device.
16391640
When this property is `False`, then the
16401641
[`$(AndroidFastDeploymentType)`](#androidfastdeploymenttype)
16411642
MSBuild property also controls what
1642-
will be embedded into the `.apk`, which can impact deployment and
1643+
will be embedded into the `.apk` or `.aab`, which can impact deployment and
16431644
rebuild times.
16441645

16451646
## EnableDiagnostics

Documentation/docs-mobile/messages/xa0119.md

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -27,8 +27,6 @@ Remove the following options from `Debug` configurations:
2727
* `<EnableProguard>True</EnableProguard>`
2828
* `<AndroidLinkTool>proguard</AndroidLinkTool>`
2929
* `<AndroidLinkTool>r8</AndroidLinkTool>`
30-
* App Bundles
31-
* `<AndroidPackageFormat>aab</AndroidPackageFormat>`
3230

3331
Remove the following from `Release` configurations:
3432

Documentation/guides/AndroidAssetPacks.md

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -125,9 +125,12 @@ away during the Release build.
125125
In order to test your asset packs in the `Debug` configuration, you will need to
126126
make some changes to your `.csproj`. Firstly we need to change the
127127
`$(AndroidPackageFormat)` to `aab`. It will be `aab` by default for `Release` builds,
128-
but will default to `apk` for `Debug` builds. Setting the `AndroidPackageFormat` to `aab`
129-
will disable fast deployment, so it is advised that you only do this when you need to test
130-
your `AssetPacks`.
128+
but will default to `apk` for `Debug` builds.
129+
130+
> [!NOTE]
131+
> Fast deployment is supported with `.aab` files. However, using `.aab` with fast deployment
132+
> will be slower than using `.apk` because the `.aab` file must be processed through `bundletool`
133+
> for packaging and installation.
131134
132135
To test your asset packs add the following to the first `<PropertyGroup/>` in your `.csproj`.
133136

0 commit comments

Comments
 (0)