Skip to content

Commit

Permalink
[TF-1990] Update documentation with latest changes doc.saucelabs.com
Browse files Browse the repository at this point in the history
- Adding documentation for AAB files
  • Loading branch information
simon-sarrafi committed Sep 9, 2024
1 parent 1ce0731 commit 61e341f
Show file tree
Hide file tree
Showing 4 changed files with 51 additions and 3 deletions.
16 changes: 16 additions & 0 deletions docs/testfairy/app-distribution/app-versioning.md
Original file line number Diff line number Diff line change
Expand Up @@ -65,3 +65,19 @@ To retain the previous app build, you have two options:
2. Change the app package name (or bundle identifier).

Since apps are grouped by package name, uploading an app with a new package name creates a new project. For example, apps with the package name `com.company.app` are grouped separately from those with `com.company.app.debug`.

## Download Your AAB File

If you uploaded an AAB file to us, we will convert it to an APK for distribution. However, you can still access your original AAB file by following these steps:

1. Navigate to Your Build: Go to the build where you uploaded the AAB file.

2. Find the App: Locate the app within the build details.

Check warning on line 75 in docs/testfairy/app-distribution/app-versioning.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/testfairy/app-distribution/app-versioning.md#L75

[sauce.WordList] Use 'in' instead of 'within'.
Raw output
{"message": "[sauce.WordList] Use 'in' instead of 'within'.", "location": {"path": "docs/testfairy/app-distribution/app-versioning.md", "range": {"start": {"line": 75, "column": 33}}}, "severity": "WARNING"}

3. Access the Detail Page: Click on the app to open its detail page.

4. Download the AAB File: Click on **More**. If the app was originally an AAB, you will find a download link in the **Attachments** section.

Use this link to download the original AAB file if needed.

<img src={useBaseUrl('/img/testfairy/app-distribution/download-aab-file.png')} alt="Download AAB file"/>
2 changes: 1 addition & 1 deletion docs/testfairy/app-distribution/symbols-file.md
Original file line number Diff line number Diff line change
Expand Up @@ -81,4 +81,4 @@ To download your symbols file through the Sauce Labs dashboard, follow these ste

By following these steps, you can easily access and download your symbols file from the dashboard.

Check warning on line 82 in docs/testfairy/app-distribution/symbols-file.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/testfairy/app-distribution/symbols-file.md#L82

[sauce.Simplicity] Remove 'easily'. Be precise instead of subjective.
Raw output
{"message": "[sauce.Simplicity] Remove 'easily'. Be precise instead of subjective.", "location": {"path": "docs/testfairy/app-distribution/symbols-file.md", "range": {"start": {"line": 82, "column": 35}}}, "severity": "WARNING"}

<img src={useBaseUrl('/img/testfairy/app-distribution/download-symbols-file-dashboard.png')} alt="add tester email"/>
<img src={useBaseUrl('/img/testfairy/app-distribution/download-symbols-file-dashboard.png')} alt="Download Symbols file"/>
36 changes: 34 additions & 2 deletions docs/testfairy/using-testfairy/uploading-an-app.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,9 +24,41 @@ The code of our command line uploader, Jenkins plugin, and Gradle plugin is open
- **iOS**: TestFairy supports uploading and distributing iOS applications. You can sign iOS apps with AdHoc, Development, or Enterprise certificates. Distributing iOS apps with TestFairy must be packaged as a `.ipa` file.
- **MacOS**: MacOS apps are bundled as `.app` files, however, to distribute MacOS apps with TestFairy, those `.app` files must be zipped into a `.zip` file.

### Choose your Build File
### Expanding iOS Platform Support: Now Including VisionOS (XROS)

In the first stage you need to choose the file you want to upload. It can be an **.ipa** (for iOS), **.apk** (for Android), or **.zip** (for MacOS) file.
We now support VisionOS in addition to all other iOS platforms. Below is the complete list of platforms. Note that **XROS** is used to indicate support for VisionOS:

Check notice on line 29 in docs/testfairy/using-testfairy/uploading-an-app.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/testfairy/using-testfairy/uploading-an-app.md#L29

[sauce.WordsToAvoid] Avoid usage of 'Note that'.
Raw output
{"message": "[sauce.WordsToAvoid] Avoid usage of 'Note that'.", "location": {"path": "docs/testfairy/using-testfairy/uploading-an-app.md", "range": {"start": {"line": 29, "column": 106}}}, "severity": "INFO"}

- iPhoneOS
- WatchOS
- MacOSX
- AppleTVOS
- DriverKit
- XROS (VisionOS)

### Supporting Both APK and AAB Formats for Android Apps

For Android apps, we support both APK and AAB formats. Here’s how it works:

Check warning on line 40 in docs/testfairy/using-testfairy/uploading-an-app.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/testfairy/using-testfairy/uploading-an-app.md#L40

[sauce.MeaningfulLinkWords] Improve SEO and accessibility by rewriting 'Here' in the link text.
Raw output
{"message": "[sauce.MeaningfulLinkWords] Improve SEO and accessibility by rewriting 'Here' in the link text.", "location": {"path": "docs/testfairy/using-testfairy/uploading-an-app.md", "range": {"start": {"line": 40, "column": 56}}}, "severity": "WARNING"}

- **APK Support:**

- If you provide your app in APK format, we handle it directly.

- **AAB Support:**
- If you upload your app as an AAB (Android App Bundle), we convert it to APK for distribution.
- We also keep a copy of your original AAB format attached to your project. This allows you to download the AAB file if needed.

Feel free to upload your app in either format, and we'll ensure it’s properly managed and available for your needs.

### Choose Your Build File

In the first stage, you need to select the file you want to upload. The supported file types are:

- **iOS:** `.ipa`
- **Android:** `.apk` or `.aab`
- **MacOS:** `.zip`
- **Windows:** Typically `.exe` or `.zip` (Please contact support for further assistance)

Check notice on line 59 in docs/testfairy/using-testfairy/uploading-an-app.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/testfairy/using-testfairy/uploading-an-app.md#L59

[sauce.WordsToAvoid] Avoid usage of 'Please'.
Raw output
{"message": "[sauce.WordsToAvoid] Avoid usage of 'Please'.", "location": {"path": "docs/testfairy/using-testfairy/uploading-an-app.md", "range": {"start": {"line": 59, "column": 44}}}, "severity": "INFO"}

Choose the appropriate file type based on your platform to proceed with the upload.

### Project Settings

Expand Down
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 61e341f

Please sign in to comment.