-
Notifications
You must be signed in to change notification settings - Fork 102
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
[TF-1990] Update documentation with latest changes doc.saucelabs.com
- Adding documentation for Symbols/dSYM upload
- Loading branch information
1 parent
c3b08ec
commit 1ce0731
Showing
5 changed files
with
98 additions
and
2 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,84 @@ | ||
--- | ||
id: symbols-file | ||
title: Upload/download Symbols file | ||
sidebar_label: Upload/download Symbols file | ||
--- | ||
|
||
import useBaseUrl from '@docusaurus/useBaseUrl'; | ||
import Tabs from '@theme/Tabs'; | ||
import TabItem from '@theme/TabItem'; | ||
|
||
### Uploading Symbols Files | ||
|
||
To ensure accurate symbolication and better management of your app's debug information, it's recommended to upload mapping files (symbols) through the API. Follow these steps to attach the file during the app upload process: | ||
|
||
### 1. Prepare the Symbols File | ||
|
||
Ensure you have the mapping file (symbols) that corresponds to your app version. This file is crucial for decoding crash reports and understanding stack traces. | ||
|
||
### 2. Upload the File via API | ||
|
||
You can upload the mapping file by using the API provided by Sauce Labs. Here's a general approach: | ||
|
||
- **Endpoint:** Use the appropriate API endpoint for uploading your app. For example: | ||
|
||
- **Attachment:** Include the mapping file `symbols_file` as part of your app submission. For instance: | ||
|
||
Android: | ||
|
||
```bash | ||
curl https://upload.testfairy.com/api/upload \ | ||
-F api_key='your_api_key' \ | ||
-F [email protected] \ | ||
-F [email protected] | ||
``` | ||
|
||
IOS: | ||
|
||
```bash | ||
curl https://upload.testfairy.com/api/upload \ | ||
-F api_key='your_api_key' \ | ||
-F [email protected] \ | ||
-F [email protected] | ||
``` | ||
|
||
### Accessing Your Symbols File | ||
|
||
After a successful upload via the API, the response will include a URL to download your Symbols file. | ||
|
||
Here’s an example of the relevant portion of the API response: | ||
|
||
```json | ||
{ | ||
"status": "ok", | ||
... | ||
"symbols_download_url": "https://mobile.testfairy.com/api/xxx/projects/xxx/builds/xxx/symbols/download/", | ||
... | ||
} | ||
``` | ||
|
||
## Accessing Symbols File Through the Dashboard | ||
|
||
To download your symbols file through the Sauce Labs dashboard, follow these steps: | ||
|
||
1. **Log In to Your Dashboard** | ||
|
||
Log in to your [Sauce Labs dashboard](https://saucelabs.com). | ||
|
||
2. **Navigate to Uploaded Apps** | ||
|
||
From the sidebar menu go to Mobile Testing and to the section where your uploaded apps are listed. Find the app that has the symbols file attached to it. | ||
|
||
3. **Access App Details** | ||
|
||
- Locate the app in the list and click on the gear icon (⚙️) at the end of the row. | ||
|
||
4. **Download Symbols File** | ||
|
||
- In the details page, click on **More**. | ||
- If a symbols file has been uploaded, you will see a **Download** link. | ||
- Click the **Download** link to retrieve your symbols file. | ||
|
||
By following these steps, you can easily access and download your symbols file from the dashboard. | ||
|
||
<img src={useBaseUrl('/img/testfairy/app-distribution/download-symbols-file-dashboard.png')} alt="add tester email"/> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Binary file added
BIN
+167 KB
static/img/testfairy/app-distribution/download-symbols-file-dashboard.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.