-
Notifications
You must be signed in to change notification settings - Fork 102
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Ss tf 1990 symbols vision os aab #2929
Changes from all commits
20e621d
514df2a
5510ba3
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
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: | ||
Check warning on line 21 in docs/testfairy/app-distribution/symbols-file.md GitHub Actions / vale[vale] docs/testfairy/app-distribution/symbols-file.md#L21
Raw output
|
||
|
||
- **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: | ||
Check warning on line 36 in docs/testfairy/app-distribution/symbols-file.md GitHub Actions / vale[vale] docs/testfairy/app-distribution/symbols-file.md#L36
Raw output
|
||
|
||
```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: | ||
Check warning on line 49 in docs/testfairy/app-distribution/symbols-file.md GitHub Actions / vale[vale] docs/testfairy/app-distribution/symbols-file.md#L49
Raw output
|
||
|
||
```json | ||
{ | ||
"status": "ok", | ||
... | ||
"symbols_download_url": "https://mobile.testfairy.com/api/xxx/projects/xxx/builds/xxx/symbols/download/", | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. doesnt the download url contains the file extension? There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. No! the download url is the api endpoint which will call the actual aws url. This url remain the same for all platforms' files |
||
... | ||
} | ||
``` | ||
|
||
## Accessing Symbols File Through the Dashboard | ||
|
||
To download your symbols file through the TestFairy dashboard, follow these steps: | ||
|
||
1. **Log In to Your Dashboard** | ||
|
||
Log in to your [Sauce Labs dashboard](https://mobile.saucelabs.com). | ||
|
||
2. **Navigate to Uploaded Apps** | ||
|
||
From the apps list, 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. | ||
Check warning on line 82 in docs/testfairy/app-distribution/symbols-file.md GitHub Actions / vale[vale] docs/testfairy/app-distribution/symbols-file.md#L82
Raw output
|
||
|
||
<img src={useBaseUrl('/img/testfairy/app-distribution/download-symbols-file-dashboard.png')} alt="Download Symbols file"/> |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@simon-sarrafi is this always txt? what other format do we support?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yes always text file for Android