Skip to content

Commit

Permalink
Add docs about the App preview feature (#2756)
Browse files Browse the repository at this point in the history
* Add docs page

* Use partials to duplicate the content for fwe and yaml

* minor edit

* Address comments

* Address comments

* Update content/partials/app-preview-builds.md

Co-authored-by: Priit Lätt <priit@nevercode.io>

---------

Co-authored-by: Priit Lätt <priit@nevercode.io>
  • Loading branch information
helinanever and priitlatt authored Sep 26, 2024
1 parent 6a853d9 commit aa9a62f
Show file tree
Hide file tree
Showing 3 changed files with 38 additions and 0 deletions.
8 changes: 8 additions & 0 deletions content/flutter-testing/app-preview.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
---
title: Previewing iOS apps on a simulator
description: How to preview and test your app on an iOS simulator
weight: 4
aliases:
---

{{< include "/partials/app-preview-builds.md" >}}
22 changes: 22 additions & 0 deletions content/partials/app-preview-builds.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
---
---

Codemagic allows you to preview your `.app` artifact on an iOS simulator and interact with the simulator via a web browser. You can easily test the functionalities of your app as well as system notifications and flows that require location data on different simulator devices without requiring a physical device.

{{<notebox>}}
Note that this feature is available for **teams** on the Pay as you go billing plan by default and can be enabled for teams on the annual plan on request.
{{</notebox>}}

## Running preview builds

You can preview any `.app` artifact built in Codemagic that targets the iOS simulator. For such artifacts, there is a **Quick Launch** button available next to the artifact name on the build overview page.

Clicking **Quick Launch** displays a configuration popup for selecting the simulator device and runtime. Once you click **Start**, Codemagic starts a preview build during which the simulator is booted and the app is installed on the simulator.

When the simulator is ready for use, you'll see the URL to access the simulator printed in the logs under the "Running iOS simulator" step as well as a link to open the simulator on the left panel of the build overview page. The simulator session remains active for a maximum of **20 minutes** or until you cancel the build.

Once the session ends, you can start a new one if needed.

## Build minutes usage

Preview builds run on a macOS machine and consume build minutes at the same per-minute rate as regular builds. If your team is on the Pay as you go plan, the minutes used for app previews will be added to your macOS minutes count.
8 changes: 8 additions & 0 deletions content/yaml-testing/app-preview.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
---
title: Previewing iOS apps on a simulator
description: How to preview and test your app on an iOS simulator
weight: 4
aliases:
---

{{< include "/partials/app-preview-builds.md" >}}

0 comments on commit aa9a62f

Please sign in to comment.