Skip to content

Commit

Permalink
reorganized version reference
Browse files Browse the repository at this point in the history
  • Loading branch information
@carlpoole
carlpoole committed Oct 16, 2023
1 parent eb1133e commit 0aa423d
Showing 1 changed file with 31 additions and 31 deletions.
62 changes: 31 additions & 31 deletions website/docs/for-android/version-matrix.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -14,35 +14,7 @@ This guide is designed to help you align versions of the Native Android Portals

Ideally, the version of Capacitor used by the Web App from NPM should match the version of Capacitor used by Portals in the native SDK. The `Compatible Capacitor Versions` column shows versions of Capacitor that are generally compatible with that version of Portals and should not cause any issues. If you are trying to target a specific version of Capacitor that contains a fix or feature you need, make sure you use the appropriate version of Portals and the Portals Plugin that is compatible.

For example, referencing the matrix below, if you are using Portals versions 0.7.1 to 0.7.3, the web plugin version should be 0.7.0 and ideally you would be using Capacitor version 4.6.1. However, Capacitor versions 4.6.3 to 4.7.0 would work.

## SDK Version Compatibility Matrix

| Android SDK | Web Plugin Version | Compiled Capacitor Version | Compatible Capacitor Versions |
| :----: | :----: | :----: | :----: |
| 0.8.3 | 0.8.1 | 5.5.+ | 5.0.3 - 5.5.0 |
| 0.8.2 | 0.8.1 | 5.4.2 | 5.0.3 - 5.5.0 |
| 0.8.1 | 0.8.1 | 5.4.2 | 5.0.3 - 5.5.0 |
| 0.8.0 | 0.8.1 | 5.0.3 | 5.0.3 - 5.5.0 |
| 0.7.5 | 0.7.1 | 4.7.3 | 4.7.0 - 4.8.0 |
| 0.7.4 | 0.7.1 | 4.7.0 | 4.7.0 - 4.8.0 |
| 0.7.3 | 0.7.0 | 4.6.1 | 4.4.0 - 4.6.3 |
| 0.7.2 | 0.7.0 | 4.6.1 | 4.4.0 - 4.6.3 |
| 0.7.1 | 0.7.0 | 4.6.1 | 4.4.0 - 4.6.3 |
| 0.7.0 | 0.7.0 | 4.5.0 | 4.4.0 - 4.6.3 |
| 0.6.4 | 0.6.0 | 3.9.0 | 3.5.1 - 3.9.0 |
| 0.6.3 | 0.6.0 | 3.7.0 | 3.5.1 - 3.9.0 |
| 0.6.2 | 0.6.0 | 3.5.1 | 3.5.1 - 3.9.0 |
| 0.6.1 | 0.6.0 | 3.5.1 | 3.5.1 - 3.9.0 |
| 0.6.0 | 0.6.0 | 3.5.1 | 3.5.1 - 3.9.0 |
| 0.5.1 | 0.5.0 | 3.5.1 | 3.5.1 - 3.9.0 |
| 0.5.0 | 0.5.0 | 3.4.1 | 3.3.0 - 3.5.0 |
| 0.4.1 | 0.4.1 | 3.4.0 | 3.3.0 - 3.5.0 |
| 0.3.1 | 0.3.1 | 3.3.3 | 3.3.0 - 3.5.0 |
| 0.3.0 | 0.3.0 | 3.3.2 | 3.3.0 - 3.5.0 |
| 0.2.2 | 0.2.2 | 3.2.5 | 3.2.2 - 3.2.5 |
| 0.2.1 | 0.2.1 | 3.2.4 | 3.2.2 - 3.2.5 |
| 0.2.0 | 0.2.0 | 3.2.2 | 3.2.2 - 3.2.5 |
For example: referencing the matrix at the bottom of the page, if you are using Portals versions 0.7.1 to 0.7.3, the web plugin version should be 0.7.0 and ideally you would be using Capacitor version 4.6.1. However, Capacitor versions 4.6.3 to 4.7.0 would work.

## How Gradle Resolves Dependency Versions

Expand All @@ -55,7 +27,7 @@ Reference: https://docs.gradle.org/current/userguide/dependency_resolution.html
Gradle allows you to use a specific version of Capacitor that Portals or a Capacitor Plugin dependency will use.

:::warning
Use the version compatibility matrix above when choosing a version of Capacitor to ensure it will be compatible. When balancing a version between Portals and a Capacitor plugin, reference the documentation or change log for the plugin to make sure the Capacitor version will be compatible.
Use the version compatibility matrix at the bottom of the page when choosing a version of Capacitor to ensure it will be compatible. When balancing a version between Portals and a Capacitor plugin, reference the documentation or change log for the plugin to make sure the Capacitor version will be compatible.
:::

The following example will use the version of the Capacitor dependency included via the Capacitor Camera plugin.
Expand Down Expand Up @@ -88,4 +60,32 @@ dependencies {

For more information refer to the Gradle documentation pages:
- https://docs.gradle.org/current/userguide/dependency_downgrade_and_exclude.html
- https://docs.gradle.org/current/userguide/dependency_constraints.html
- https://docs.gradle.org/current/userguide/dependency_constraints.html

# SDK Version Compatibility Matrix

| Android SDK | Web Plugin Version | Compiled Capacitor Version | Compatible Capacitor Versions |
| :----: | :----: | :----: | :----: |
| 0.8.3 | 0.8.1 | 5.5.+ | 5.0.3 - 5.5.0 |
| 0.8.2 | 0.8.1 | 5.4.2 | 5.0.3 - 5.5.0 |
| 0.8.1 | 0.8.1 | 5.4.2 | 5.0.3 - 5.5.0 |
| 0.8.0 | 0.8.1 | 5.0.3 | 5.0.3 - 5.5.0 |
| 0.7.5 | 0.7.1 | 4.7.3 | 4.7.0 - 4.8.0 |
| 0.7.4 | 0.7.1 | 4.7.0 | 4.7.0 - 4.8.0 |
| 0.7.3 | 0.7.0 | 4.6.1 | 4.4.0 - 4.6.3 |
| 0.7.2 | 0.7.0 | 4.6.1 | 4.4.0 - 4.6.3 |
| 0.7.1 | 0.7.0 | 4.6.1 | 4.4.0 - 4.6.3 |
| 0.7.0 | 0.7.0 | 4.5.0 | 4.4.0 - 4.6.3 |
| 0.6.4 | 0.6.0 | 3.9.0 | 3.5.1 - 3.9.0 |
| 0.6.3 | 0.6.0 | 3.7.0 | 3.5.1 - 3.9.0 |
| 0.6.2 | 0.6.0 | 3.5.1 | 3.5.1 - 3.9.0 |
| 0.6.1 | 0.6.0 | 3.5.1 | 3.5.1 - 3.9.0 |
| 0.6.0 | 0.6.0 | 3.5.1 | 3.5.1 - 3.9.0 |
| 0.5.1 | 0.5.0 | 3.5.1 | 3.5.1 - 3.9.0 |
| 0.5.0 | 0.5.0 | 3.4.1 | 3.3.0 - 3.5.0 |
| 0.4.1 | 0.4.1 | 3.4.0 | 3.3.0 - 3.5.0 |
| 0.3.1 | 0.3.1 | 3.3.3 | 3.3.0 - 3.5.0 |
| 0.3.0 | 0.3.0 | 3.3.2 | 3.3.0 - 3.5.0 |
| 0.2.2 | 0.2.2 | 3.2.5 | 3.2.2 - 3.2.5 |
| 0.2.1 | 0.2.1 | 3.2.4 | 3.2.2 - 3.2.5 |
| 0.2.0 | 0.2.0 | 3.2.2 | 3.2.2 - 3.2.5 |

0 comments on commit 0aa423d

Please sign in to comment.