Run previews with the iPhone app
Install the Tuist iOS app from the App Store to find and access your Apple previews. The publication workflow's signing and device eligibility requirements still apply.
Search by app name or release notes, then select a track to filter previews. Choose All to browse every track, including previews without a track. Open a preview to read its full release notes.
Client and server compatibility#
Keep the Tuist app up to date. If you self-host Tuist, update your server to use track filtering and release notes. You can still browse previews without filtering on older servers.
In-app update notifications#
The Tuist SDK enables your Apple app to detect a newer preview and notify testers. It checks for updates within the same preview track. For previews published with tuist share --track, it uses that explicit track. Without an explicit track, the git branch is used, so a preview built from main only notifies about newer previews from main.
Installation#
Add Tuist SDK as a Swift Package dependency:
.package(url: "https://github.com/tuist/sdk", .upToNextMajor(from: "0.1.0"))
Monitor for updates#
Use monitorPreviewUpdates to periodically check for new preview versions:
import TuistSDK
struct MyApp: App {
var body: some Scene {
WindowGroup {
ContentView()
.task {
TuistSDK(
fullHandle: "myorg/myapp",
apiKey: "your-api-key"
)
.monitorPreviewUpdates()
}
}
}
}
Single update check#
For manual update checking:
let sdk = TuistSDK(
fullHandle: "myorg/myapp",
apiKey: "your-api-key"
)
if let preview = try await sdk.checkForUpdate() {
print("New version available: \(preview.version ?? "unknown")")
}
Stopping update monitoring#
monitorPreviewUpdates returns a Task that can be cancelled:
let task = sdk.monitorPreviewUpdates { preview in
// Handle update
}
// Later, to stop monitoring:
task.cancel()
Update checking is automatically disabled on simulators and App Store builds.