ci: auto-regenerate API docs on release

Author: fadi-george

.github/workflows/create-release-pr.yml

@@ -157,6 +157,15 @@ jobs:
           git diff --staged --quiet && exit 0
           git commit -m "Release $NEW_VERSION" && git push
 
+      - name: Regenerate API docs
+        run: |
+          vp run docgen
+
+          # Only commit if there are changes
+          git add -A
+          git diff --staged --quiet && exit 0
+          git commit -m "Regenerate docs for ${{ inputs.capacitor_version }}" && git push
+
   create-pr:
     needs: [prep, update_version]
     uses: OneSignal/sdk-shared/.github/workflows/create-release.yml@main

README.md

@@ -163,12 +163,6 @@ Current-user operations exposed via `OneSignal.User`.
 
 Push subscription state and controls exposed via `OneSignal.User.pushSubscription`.
 
-| Prop          | Type                        |
-| ------------- | --------------------------- |
-| **`id`**      | <code>string \| null</code> |
-| **`token`**   | <code>string \| null</code> |
-| **`optedIn`** | <code>boolean</code>        |
-
 | Method                  | Signature                                                                                                                            | Description                                                                                                                                                                                         |
 | ----------------------- | ------------------------------------------------------------------------------------------------------------------------------------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
 | **getIdAsync**          | () =&gt; Promise&lt;string \| null&gt;                                                                                               | Get the current device's push subscription ID, or null if not yet assigned.                                                                                                                         |