Skip to content
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.

Sign up for GitHub

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

Jump to bottom

chore(docs): Add differential documentation to fedcap #278

Merged
merged 1 commit into from
May 31, 2024
Merged

chore(docs): Add differential documentation to fedcap #278

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 5 additions & 2 deletions website/docs/for-capacitor/live-updates.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,14 +14,16 @@ First let's add Live Updates to the main shell application. Modify the `capacito
liveUpdateConfig: {
appId: "YOUR_APP_ID_IN_APPFLOW",
channel: "production",
autoUpdateMethod: "none"
autoUpdateMethod: "none",
strategy: "differential"
}
},
```

- **appId**: Replace `YOUR_APP_ID_IN_APPFLOW` with your own id. (example: `e9597b11`)
- **channel**: By default all releases happen in Appflow from the `production` channel but you can setup whatever channel you need here.
- **autoUpdateMethod**: Options would be `none` or `background`. You would choose `none` if you want to call the update method on your own, but the most common choice here would be `background` where the updates happen automatically.
- **strategy**: Options would be `zip` or `differential`. `zip` is the default and will download the entire update each time. `differential` will only download the changes between the current version and the new version.

After you have made these changes and done a build the application will begin pulling updates from Appflow using the IDs that you have provided. See the [reference](reference) documentation for methods on performing live updates manually from your application code.

Expand All @@ -39,7 +41,8 @@ Modify the `capacitor.config.ts` file to add a `liveUpdatesKey` field to the Fed
liveUpdateConfig: {
appId: "YOUR_APP_ID_IN_APPFLOW",
channel: "production",
autoUpdateMethod: "none"
autoUpdateMethod: "none",
strategy: "differential"
}
},
```
Expand Down
1 change: 1 addition & 0 deletions website/docs/for-capacitor/reference.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -92,6 +92,7 @@ Sync Some
| **`channel`** | <code>string</code> |
| **`autoUpdateMethod`** | <code><a href="#autoupdatemethod">AutoUpdateMethod</a></code> |
| **`maxVersions`** | <code>number</code> |
| **`strategy`** | <code>'zip' \| 'differential'</code> |
| **`key`** | <code>string</code> |


Expand Down
5 changes: 5 additions & 0 deletions website/docs/for-capacitor/upgrade-guides.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,11 @@ title: Upgrade Guides
sidebar_label: Upgrade Guides
---

## @ionic-enterprise/federated-capacitor 0.1.7

### Differential Support
Differential Live Update support has been added with this release. See the [Live Updates](live-updates) documentation for more information on how to configure this feature.

## @ionic-enterprise/federated-capacitor 0.1.0

'Portals for Capacitor' has been rebranded as 'Federated Capacitor'. This has come with
Expand Down
Loading