docs: add @NativePlugin removal to Capacitor 9 upgrade guide - #586
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
There was a problem hiding this comment.
I'm thinking whether or not this is better suited for updating plugins to 9.0 rather than updating apps. Maybe they could have a place in both but updating plugins seems like a better place, since @NativePlugin and Plugin apis would be consumed by Capacitor Plugins, not apps.
That would mean to tie this PR to #590 instead?
What do you think @OS-ruimoreiramendes @andredestro?
There was a problem hiding this comment.
Makes sense, everything here is only reachable from plugin code, so the plugin guide is the better home for it.
I can re-base this PR on #590 and move the content into docs/main/updating/plugins/9-0.md, but let's see what @andredestro thinks before I move it.
There was a problem hiding this comment.
Agreed, the plugin guide is the right home. plugins/7-0.md already has a "Breaking changes in code" section for exactly this. #590 just needs that section added at the top.
There was a problem hiding this comment.
Sounds good. @andredestro since #590 is yours, does it make sense for you to add the "Breaking changes in code" section header there, and then I rebase this PR on top and drop the content into that section? Or if you prefer, I can do it myself.
c7863b4 to
8c8b6f2
Compare
3 participants
Description
Extends the "Breaking changes in @capacitor/android" section in the "Updating to 9.0" upgrade guide (
docs/main/updating/9-0.md) with a subsection for the removal of the legacy@NativePluginannotation and its associated deprecated permission/activity-result APIs.The new subsection documents the annotation removal (with a pointer to the Capacitor 3 plugin migration guide for the overall migration pattern) and provides a replacement table for each removed method.
Change Type
Rationale / Problems Fixed
Capacitor 9 removes the legacy
@NativePluginecosystem (see ionic-team/capacitor#8563 / RMET-5305).Plugin authors and app developers hitting compile errors after upgrading need a place that maps each removed API to its replacement, alongside the rest of the Android deprecated API removals from ionic-team/capacitor#8564.
Tests or Reproductions
Content was verified against the actual removals in ionic-team/capacitor#8563 and ionic-team/capacitor#8564 : every removed symbol listed in the guide matches the source changes. Replacements were taken directly from the
@deprecatedjavadoc annotations on the removed methods where available, and from the modern equivalents in the same files for the two methods without explicit replacement notes (Plugin.startActivityForResult(int)andBridge.startActivityForPluginWithResult(int)).Platforms Affected
Notes / Comments
chore/RMET-5304-cap9-android-deprecated-apis(docs: add Android deprecated API removals to Capacitor 9 upgrade guide #581) sincedocs/main/updating/9-0.mddoes not yet exist onmain. Once docs: add Android deprecated API removals to Capacitor 9 upgrade guide #581 merges, this PR needs a trivial rebase ontomain.