Skip to content

Commit

Permalink
Updated Text Flow, Corrected page linking, fixed grammar errors (#3050)
Browse files Browse the repository at this point in the history
Under Configuring Auto-Update, reorganized the two ways to configure auto-update to be in the same order as they are on the page:

FROM
- Via Upload API
- In build settings

TO
- In Build Settings
- Via Upload API

Fixed Upload API page reference under Via Upload API:

FROM
upload api /testfairy/api-reference/upload-api

TO
[upload API](/testfairy/api-reference/upload-api)

Updated some random grammar errors and formatting errors.

Co-authored-by: Simon Schaefer <[email protected]>
  • Loading branch information
lee-snyder133 and si-net authored Jan 10, 2025
1 parent efc97a1 commit 899a31f
Showing 1 changed file with 7 additions and 7 deletions.
14 changes: 7 additions & 7 deletions docs/testfairy/app-distribution/auto-update.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,8 +18,8 @@ Auto-update is not available in production.

There are two ways to configure auto-update for a specific build:

- In Build Settings
- Via Upload API
- In build settings

### In Build Settings

Expand All @@ -29,7 +29,7 @@ After uploading a build, access the build settings and navigate to the **App Dis

### Via Upload API

When uploading a new build via the upload api /testfairy/api-reference/upload-api, set the `auto-update` parameter to `on`.
When uploading a new build via the [upload API](/testfairy/api-reference/upload-api), set the `auto-update` parameter to `on`.

### Implementing Auto Update in Your App

Expand All @@ -47,7 +47,7 @@ curl -XPOST \
-F bundleShortVersion=2.0.1
```

And the response would include to fields, "status" and "autoUpdateDownloadUrl" (optional). Like so:
And the response would include the fields "status" and "autoUpdateDownloadUrl" (optional). Like so:

```json title="Sample Response"
{
Expand All @@ -57,20 +57,20 @@ And the response would include to fields, "status" and "autoUpdateDownloadUrl" (
```

- `status`: Is the distribution of the current version still allowed? Useful for invalidating specific versions after distribution.
- `autoUpdateDownloadUrl`: Optional string, if available, points out to the url the end user needs to open in a browser.
- `autoUpdateDownloadUrl`: Optional string, if available, points to the URL the end user needs to open in a browser.

### Reasons Auto-Update May Fail

Auto-update may fail for the following reasons:

- The version number and name of the new build are the same as the old one. Auto-update only works when versions are different.
- (iOS) The app is not signed with an ad-hoc or enterprise certificate.
- (Android) The sign certificates for each version is different. If an app does not sign with the same certificate, auto-update is rejected. This is because it's impossible to install the new version without previously uninstalling the current one.
- (Android) The sign certificates for each version are different. If an app does not sign with the same certificate, auto-update is rejected. This is because it's impossible to install the new version without previously uninstalling the current one.

### Notes on Security

`getDistributionStatus` is called from within your mobile app. It uses **TestFairy App Token**, which is a public token that cannot be used to make changes on the platform.

If your app is publicly available for download, the returned url is for a direct download (only for Android). Otherwise, the returned url is of a download page, which will require re-authentication before build can be downloaded.
If your app is publicly available for download, the returned URL is for a direct download (only for Android). Otherwise, the returned URL is of a download page, which will require re-authentication before the build can be downloaded.

Also note, that there can be only 1 build version marked for auto-update. This may point to any version, not necessarily a version that the current tester has been invited to. Please plan your auto-update policy.
Also, note that only 1 build version can be marked for auto-update. This may point to any version, not necessarily a version that the current tester has been invited to. Please plan your auto-update policy.

0 comments on commit 899a31f

Please sign in to comment.