docs: add Capacitor 9 plugin upgrade guide - #590
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
|
|
||
| ## Using @capacitor/plugin-migration-v8-to-v9 | ||
|
|
||
| From the plugin folder, run `npx @capacitor/plugin-migration-v8-to-v9@latest` and it will perform most of the file changes automatically. |
There was a problem hiding this comment.
This doesn't exist yet, and maybe would only exist when Capacitor 9 reaches GA? Or we could generate a prerelease for it (no prerelease exists yet)? Or, because the plugin-migration packages are in 0.x, perhaps it's fine to do a stable release?
Should we decide that (whether or not to release the plugin migrator for Cap 9 unstable version) before merging this PR (decision can potentially be done outside this PR)?
There was a problem hiding this comment.
Agreed this can be decided outside this PR. Leaning towards a 0.x prerelease/prerelease-tag publish once we're closer to stabilizing the Cap 9 changes, rather than a stable release while Cap 9 itself is still alpha, but let's track that decision separately rather than block this guide on it.
6dd69f7 to
e4ff100
Compare
Covers plugin-author changes (Cordova-optional implications for plugins, Android/iOS breaking changes, gradle plugin variable bumps, using the plugin-migration-v8-to-v9 tool). Cross-links with the app upgrade guide added in the previous commit. RMET-5321
e4ff100 to
0400079
Compare
- Pin capacitor-swift-pm and the peerDependencies example to the latest alpha (9.0.0-alpha.6); earlier alphas had Cordova Optionality crashes. Use "prerelease" instead of "alpha" in the general wording so it doesn't go stale once Capacitor 9 reaches beta. - Clarify the uniquePackageNames namespace collision wording - Add a "Rename the default ProGuard file" section, since community plugins/forks may still reference proguard-android.txt - Point to the 8.5 UIScene audit section from the iOS deployment target step Addresses review comments from @OS-pedrogustavobilro on PR #590.
3 participants
Description
Adds
docs/main/updating/plugins/9-0.md, the "Updating plugins to 9.0" guide for Capacitor plugin authors, and registers it in the Upgrade Guides sidebar. Also cross-links it with the app upgrade guide (main/updating/9-0.md) added in the base branch.Covers plugin-author changes:
@capacitor/plugin-migration-v8-to-v9CLI tool, and updatingpackage.jsondependencies manually (nextin devDependencies,>=9.0.0-alpha.1in peerDependencies)Cordovaproduct fromPackage.swifttargetSdkVersion, migratingcore-ktxtocorejcenter()android.uniquePackageNamestotrue)capacitor-swift-pmdependencyChange Type
Rationale / Problems Fixed
Plugin authors upgrading to Capacitor 9 need a single reference for what changed in their build/dependency setup, separate from the app-level guide, so the Capacitor CLI and other components can link to it.
Internal Jira reference: https://outsystemsrd.atlassian.net/browse/RMET-5321
Screenshots / Media
N/A
Platforms Affected