Update to release changelog new notes for React Native and the web pl…

…ugin. (#245)
ionic-team · Oct 30, 2023 · 36834b7 · 36834b7
1 parent d437b4d
commit 36834b7
Show file tree

Hide file tree

Showing 3 changed files with 27 additions and 88 deletions.
diff --git a/scripts/changelog-release.mjs b/scripts/changelog-release.mjs
@@ -74,7 +74,11 @@ function formatReleases(releases, repo, productTitle, pageUrl) {
         if (release.url.includes("/ionic-team/ionic-portals-ios/")) {
           return semver.lt("0.5.1", release.tag_name);
         } else if (release.url.includes("/ionic-team/ionic-portals/")) {
-          return semver.lt("0.7.0", release.tag_name);
+          return semver.lt("0.6.0", release.tag_name);
+        } else if (
+          release.url.includes("/ionic-team/ionic-portals-react-native/")
+        ) {
+          return semver.lt("0.1.0", release.tag_name);
         }
         return true;
       })

diff --git a/website/docs/for-react-native/changelog.json b/website/docs/for-react-native/changelog.json
@@ -16,8 +16,8 @@
     "productTitle": "Portals React Native",
     "pageUrl": "https://ionic.io/docs/portals/for-react-native/changelog",
     "repo": "ionic-team/ionic-portals-react-native",
-    "mdBody": "### What's Changed\n* **feat!**: Update to IonicPortals 0.8.0 ([#47](https://github.com/ionic-team/ionic-portals-react-native/pull/47))\n\n",
-    "body": "<h3>What's Changed</h3>\n<ul>\n<li><strong>feat!</strong>: Update to IonicPortals 0.8.0 (<a href=\"https://github.com/ionic-team/ionic-portals-react-native/pull/47\">#47</a>)</li>\n</ul>\n",
+    "mdBody": "React Native Portals now uses Capacitor 5.\n\nTo upgrade from the previous release please reference the [UPGRADE GUIDE](https://ionic.io/docs/portals/for-react-native/upgrade-guides#portals-for-react-native-040--050).\n\n### What's Changed\n* **feat!**: Update to IonicPortals 0.8.0 ([#47](https://github.com/ionic-team/ionic-portals-react-native/pull/47))\n\n",
+    "body": "<p>React Native Portals now uses Capacitor 5.</p>\n<p>To upgrade from the previous release please reference the <a href=\"https://ionic.io/docs/portals/for-react-native/upgrade-guides#portals-for-react-native-040--050\">UPGRADE GUIDE</a>.</p>\n<h3>What's Changed</h3>\n<ul>\n<li><strong>feat!</strong>: Update to IonicPortals 0.8.0 (<a href=\"https://github.com/ionic-team/ionic-portals-react-native/pull/47\">#47</a>)</li>\n</ul>\n",
     "name": "0.5.0",
     "raw_published_at": "2023-09-20T23:36:26Z",
     "published_at": "September 20 2023",
@@ -42,8 +42,8 @@
     "productTitle": "Portals React Native",
     "pageUrl": "https://ionic.io/docs/portals/for-react-native/changelog",
     "repo": "ionic-team/ionic-portals-react-native",
-    "mdBody": "### What's Changed\n* **feat!**: BREAKING - Plugin Registration Unification ([#40](https://github.com/ionic-team/react-native-ionic-portals/pull/40))\n* **feat!**: Adds more information regarding a successful live update ([#39](https://github.com/ionic-team/react-native-ionic-portals/pull/39))\n* **feat**: Asset maps ([#41](https://github.com/ionic-team/react-native-ionic-portals/pull/41))\n* **feat**: Web vitals ([#42](https://github.com/ionic-team/react-native-ionic-portals/pull/42))\n\n\n",
-    "body": "<h3>What's Changed</h3>\n<ul>\n<li><strong>feat!</strong>: BREAKING - Plugin Registration Unification (<a href=\"https://github.com/ionic-team/react-native-ionic-portals/pull/40\">#40</a>)</li>\n<li><strong>feat!</strong>: Adds more information regarding a successful live update (<a href=\"https://github.com/ionic-team/react-native-ionic-portals/pull/39\">#39</a>)</li>\n<li><strong>feat</strong>: Asset maps (<a href=\"https://github.com/ionic-team/react-native-ionic-portals/pull/41\">#41</a>)</li>\n<li><strong>feat</strong>: Web vitals (<a href=\"https://github.com/ionic-team/react-native-ionic-portals/pull/42\">#42</a>)</li>\n</ul>\n",
+    "mdBody": "### New Feature Asset Maps\nIf you are developing an application that contains multiple Portals, the Portals library supports the ability to share asset files between them. This is helpful to reduce the size of your overall app if those Portals use assets that are the same such as large media files or font files. These are called Asset Maps. You can find out more about how to use them [here](https://ionic.io/docs/portals/for-react-native/how-to/sharing-assets).\n\n### New Feature Web Vitals\nYou can now observe the FCP (First Contentful Paint) on a specific Portal. A faster FCP has several key benefits for. It enhances user perception by providing quick visual feedback that a web app is loading and can reduce the perception of delay. To read about how to make use of these new feature you can read the documentation [here](https://ionic.io/docs/portals/for-web/web-vitals#react-native)\n\n### New Feature Plugin Registration\nThere are now options for how to register plugins for a given Portal. This provides more control for React Native developers. You can read more about how to use the feature [here](https://ionic.io/docs/portals/for-react-native/how-to/using-a-capacitor-plugin)\n\nTo upgrade from the previous release please reference the [UPGRADE GUIDE](https://ionic.io/docs/portals/for-react-native/upgrade-guides#portals-for-react-native-030--040).\n\n### What's Changed\n* **feat!**: BREAKING - Plugin Registration Unification ([#40](https://github.com/ionic-team/react-native-ionic-portals/pull/40))\n* **feat!**: Adds more information regarding a successful live update ([#39](https://github.com/ionic-team/react-native-ionic-portals/pull/39))\n* **feat**: Asset maps ([#41](https://github.com/ionic-team/react-native-ionic-portals/pull/41))\n* **feat**: Web vitals ([#42](https://github.com/ionic-team/react-native-ionic-portals/pull/42))\n\n\n",
+    "body": "<h3>New Feature Asset Maps</h3>\n<p>If you are developing an application that contains multiple Portals, the Portals library supports the ability to share asset files between them. This is helpful to reduce the size of your overall app if those Portals use assets that are the same such as large media files or font files. These are called Asset Maps. You can find out more about how to use them <a href=\"https://ionic.io/docs/portals/for-react-native/how-to/sharing-assets\">here</a>.</p>\n<h3>New Feature Web Vitals</h3>\n<p>You can now observe the FCP (First Contentful Paint) on a specific Portal. A faster FCP has several key benefits for. It enhances user perception by providing quick visual feedback that a web app is loading and can reduce the perception of delay. To read about how to make use of these new feature you can read the documentation <a href=\"https://ionic.io/docs/portals/for-web/web-vitals#react-native\">here</a></p>\n<h3>New Feature Plugin Registration</h3>\n<p>There are now options for how to register plugins for a given Portal. This provides more control for React Native developers. You can read more about how to use the feature <a href=\"https://ionic.io/docs/portals/for-react-native/how-to/using-a-capacitor-plugin\">here</a></p>\n<p>To upgrade from the previous release please reference the <a href=\"https://ionic.io/docs/portals/for-react-native/upgrade-guides#portals-for-react-native-030--040\">UPGRADE GUIDE</a>.</p>\n<h3>What's Changed</h3>\n<ul>\n<li><strong>feat!</strong>: BREAKING - Plugin Registration Unification (<a href=\"https://github.com/ionic-team/react-native-ionic-portals/pull/40\">#40</a>)</li>\n<li><strong>feat!</strong>: Adds more information regarding a successful live update (<a href=\"https://github.com/ionic-team/react-native-ionic-portals/pull/39\">#39</a>)</li>\n<li><strong>feat</strong>: Asset maps (<a href=\"https://github.com/ionic-team/react-native-ionic-portals/pull/41\">#41</a>)</li>\n<li><strong>feat</strong>: Web vitals (<a href=\"https://github.com/ionic-team/react-native-ionic-portals/pull/42\">#42</a>)</li>\n</ul>\n",
     "name": "0.4.0",
     "raw_published_at": "2023-04-05T14:28:36Z",
     "published_at": "April 5 2023",
@@ -76,83 +76,5 @@
     "tag_name": "0.2.0",
     "type": "minor",
     "version": "0.2.0"
-  },
-  {
-    "productTitle": "Portals React Native",
-    "pageUrl": "https://ionic.io/docs/portals/for-react-native/changelog",
-    "repo": "ionic-team/ionic-portals-react-native",
-    "mdBody": "### What's Changed\n* **feat**: configurable entry point ([#23](https://github.com/ionic-team/react-native-ionic-portals/pull/23))\n* **breaking**: single portal prop ([#24](https://github.com/ionic-team/react-native-ionic-portals/pull/24))\n\n",
-    "body": "<h3>What's Changed</h3>\n<ul>\n<li><strong>feat</strong>: configurable entry point (<a href=\"https://github.com/ionic-team/react-native-ionic-portals/pull/23\">#23</a>)</li>\n<li><strong>breaking</strong>: single portal prop (<a href=\"https://github.com/ionic-team/react-native-ionic-portals/pull/24\">#24</a>)</li>\n</ul>\n",
-    "name": "0.1.0",
-    "raw_published_at": "2022-08-16T16:49:04Z",
-    "published_at": "August 16 2022",
-    "tag_name": "0.1.0",
-    "type": "minor",
-    "version": "0.1.0"
-  },
-  {
-    "productTitle": "Portals React Native",
-    "pageUrl": "https://ionic.io/docs/portals/for-react-native/changelog",
-    "repo": "ionic-team/ionic-portals-react-native",
-    "mdBody": "### What's Changed\n* **fix(android)**: changed layout behavior to fix render issue ([#21](https://github.com/ionic-team/react-native-ionic-portals/pull/21))\n\n\n\n",
-    "body": "<h3>What's Changed</h3>\n<ul>\n<li><strong>fix(android)</strong>: changed layout behavior to fix render issue (<a href=\"https://github.com/ionic-team/react-native-ionic-portals/pull/21\">#21</a>)</li>\n</ul>\n",
-    "name": "0.0.6",
-    "raw_published_at": "2022-07-18T15:44:56Z",
-    "published_at": "July 18 2022",
-    "tag_name": "0.0.6",
-    "type": "patch",
-    "version": "0.0.6"
-  },
-  {
-    "productTitle": "Portals React Native",
-    "pageUrl": "https://ionic.io/docs/portals/for-react-native/changelog",
-    "repo": "ionic-team/ionic-portals-react-native",
-    "mdBody": "### What's Changed\n* **fix(ios)**: initialContext not always set before name ([#17](https://github.com/ionic-team/react-native-ionic-portals/pull/17))\n* **chore(docs)**: Add `pre_install` hook instructions for Podfile ([#18](https://github.com/ionic-team/react-native-ionic-portals/pull/18))\n\n",
-    "body": "<h3>What's Changed</h3>\n<ul>\n<li><strong>fix(ios)</strong>: initialContext not always set before name (<a href=\"https://github.com/ionic-team/react-native-ionic-portals/pull/17\">#17</a>)</li>\n<li><strong>chore(docs)</strong>: Add <code>pre_install</code> hook instructions for Podfile (<a href=\"https://github.com/ionic-team/react-native-ionic-portals/pull/18\">#18</a>)</li>\n</ul>\n",
-    "name": "0.0.5",
-    "raw_published_at": "2022-07-01T15:53:46Z",
-    "published_at": "July 1 2022",
-    "tag_name": "0.0.5",
-    "type": "patch",
-    "version": "0.0.5"
-  },
-  {
-    "productTitle": "Portals React Native",
-    "pageUrl": "https://ionic.io/docs/portals/for-react-native/changelog",
-    "repo": "ionic-team/ionic-portals-react-native",
-    "mdBody": "### What's Changed\n* **chore**: iOS portals 0.6.1 ([#13](https://github.com/ionic-team/react-native-ionic-portals/pull/13))\n* **feat**: Live updates ([#14](https://github.com/ionic-team/react-native-ionic-portals/pull/14))\n* **fix(android)**: initial context ([#15](https://github.com/ionic-team/react-native-ionic-portals/pull/15))\n\n",
-    "body": "<h3>What's Changed</h3>\n<ul>\n<li><strong>chore</strong>: iOS portals 0.6.1 (<a href=\"https://github.com/ionic-team/react-native-ionic-portals/pull/13\">#13</a>)</li>\n<li><strong>feat</strong>: Live updates (<a href=\"https://github.com/ionic-team/react-native-ionic-portals/pull/14\">#14</a>)</li>\n<li><strong>fix(android)</strong>: initial context (<a href=\"https://github.com/ionic-team/react-native-ionic-portals/pull/15\">#15</a>)</li>\n</ul>\n",
-    "name": "0.0.4",
-    "raw_published_at": "2022-06-24T20:28:49Z",
-    "published_at": "June 24 2022",
-    "tag_name": "0.0.4",
-    "type": "patch",
-    "version": "0.0.4"
-  },
-  {
-    "productTitle": "Portals React Native",
-    "pageUrl": "https://ionic.io/docs/portals/for-react-native/changelog",
-    "repo": "ionic-team/ionic-portals-react-native",
-    "mdBody": "### What's Changed\n* Pub/Sub Fix (again) ([#11](https://github.com/ionic-team/react-native-ionic-portals/pull/11))\n\n",
-    "body": "<h3>What's Changed</h3>\n<ul>\n<li>Pub/Sub Fix (again) (<a href=\"https://github.com/ionic-team/react-native-ionic-portals/pull/11\">#11</a>)</li>\n</ul>\n",
-    "name": "0.0.3",
-    "raw_published_at": "2022-06-02T15:19:12Z",
-    "published_at": "June 2 2022",
-    "tag_name": "0.0.3",
-    "type": "patch",
-    "version": "0.0.3"
-  },
-  {
-    "productTitle": "Portals React Native",
-    "pageUrl": "https://ionic.io/docs/portals/for-react-native/changelog",
-    "repo": "ionic-team/ionic-portals-react-native",
-    "mdBody": "### What's Changed\n* Pub sub fix ([#9](https://github.com/ionic-team/react-native-ionic-portals/pull/9))\n\n",
-    "body": "<h3>What's Changed</h3>\n<ul>\n<li>Pub sub fix (<a href=\"https://github.com/ionic-team/react-native-ionic-portals/pull/9\">#9</a>)</li>\n</ul>\n",
-    "name": "0.0.2",
-    "raw_published_at": "2022-06-01T15:54:07Z",
-    "published_at": "June 1 2022",
-    "tag_name": "0.0.2",
-    "type": "patch",
-    "version": "0.0.2"
   }
 ]
diff --git a/website/docs/for-web/changelog.json b/website/docs/for-web/changelog.json
@@ -16,8 +16,8 @@
     "productTitle": "Portals Web Plugin",
     "pageUrl": "https://ionic.io/docs/portals/for-web/changelog",
     "repo": "ionic-team/ionic-portals",
-    "mdBody": "### What's Changed\n* **feat**: BREAKING! Overhauls to pub/sub ([#222](https://github.com/ionic-team/ionic-portals/pull/222))\n* **chore**: Update method for retrieving initial context on Android ([#226](https://github.com/ionic-team/ionic-portals/pull/226))\n\n",
-    "body": "<h3>What's Changed</h3>\n<ul>\n<li><strong>feat</strong>: BREAKING! Overhauls to pub/sub (<a href=\"https://github.com/ionic-team/ionic-portals/pull/222\">#222</a>)</li>\n<li><strong>chore</strong>: Update method for retrieving initial context on Android (<a href=\"https://github.com/ionic-team/ionic-portals/pull/226\">#226</a>)</li>\n</ul>\n",
+    "mdBody": "### Pub/Sub system overhaul\nThis update simplifies the pub/sub system for Ionic Portals, addressing the issue of Plugin subscriptions not being properly disposed when a Portal is dismissed. More details on usage can be found [here](https://ionic.io/docs/portals/for-web/portals-plugin#methods). Key improvements include:\n\n- Utilizing Capacitor for Event Handling:\nWe now use Capacitor for event publishing, simplifying unsubscribing with provided handles, eliminating the need for arbitrary integers.\n\nTo upgrade from the previous release please reference the [UPGRADE GUIDE](https://ionic.io/docs/portals/for-web/upgrade-guides#portals-web-plugin-07x--080).\n\n### What's Changed\n* **feat**: BREAKING! Overhauls to pub/sub ([#222](https://github.com/ionic-team/ionic-portals/pull/222))\n* **chore**: Update method for retrieving initial context on Android ([#226](https://github.com/ionic-team/ionic-portals/pull/226))\n\n",
+    "body": "<h3>Pub/Sub system overhaul</h3>\n<p>This update simplifies the pub/sub system for Ionic Portals, addressing the issue of Plugin subscriptions not being properly disposed when a Portal is dismissed. More details on usage can be found <a href=\"https://ionic.io/docs/portals/for-web/portals-plugin#methods\">here</a>. Key improvements include:</p>\n<ul>\n<li>Utilizing Capacitor for Event Handling:\nWe now use Capacitor for event publishing, simplifying unsubscribing with provided handles, eliminating the need for arbitrary integers.</li>\n</ul>\n<p>To upgrade from the previous release please reference the <a href=\"https://ionic.io/docs/portals/for-web/upgrade-guides#portals-web-plugin-07x--080\">UPGRADE GUIDE</a>.</p>\n<h3>What's Changed</h3>\n<ul>\n<li><strong>feat</strong>: BREAKING! Overhauls to pub/sub (<a href=\"https://github.com/ionic-team/ionic-portals/pull/222\">#222</a>)</li>\n<li><strong>chore</strong>: Update method for retrieving initial context on Android (<a href=\"https://github.com/ionic-team/ionic-portals/pull/226\">#226</a>)</li>\n</ul>\n",
     "name": "0.8.0",
     "raw_published_at": "2023-05-17T20:58:22Z",
     "published_at": "May 17 2023",
@@ -29,13 +29,26 @@
     "productTitle": "Portals Web Plugin",
     "pageUrl": "https://ionic.io/docs/portals/for-web/changelog",
     "repo": "ionic-team/ionic-portals",
-    "mdBody": "### What's Changed\n\n* **feat(plugin)**: Add `assetMaps` key to initialContext ([#209](https://github.com/ionic-team/ionic-portals/pull/209))\n\n\n\n",
-    "body": "<h3>What's Changed</h3>\n<ul>\n<li><strong>feat(plugin)</strong>: Add <code>assetMaps</code> key to initialContext (<a href=\"https://github.com/ionic-team/ionic-portals/pull/209\">#209</a>)</li>\n</ul>\n",
+    "mdBody": "### New Feature Asset Maps\nIf you are developing an application that contains multiple Portals, the Portals library supports the ability to share asset files between them. This is helpful to reduce the size of your overall app if those Portals use assets that are the same such as large media files or font files. These are called Asset Maps. You can find out more about how to use them [here](https://ionic.io/docs/portals/for-web/sharing-assets#register-shared-assets).\n\n### What's Changed\n\n* **feat(plugin)**: Add `assetMaps` key to initialContext ([#209](https://github.com/ionic-team/ionic-portals/pull/209))\n\n\n\n",
+    "body": "<h3>New Feature Asset Maps</h3>\n<p>If you are developing an application that contains multiple Portals, the Portals library supports the ability to share asset files between them. This is helpful to reduce the size of your overall app if those Portals use assets that are the same such as large media files or font files. These are called Asset Maps. You can find out more about how to use them <a href=\"https://ionic.io/docs/portals/for-web/sharing-assets#register-shared-assets\">here</a>.</p>\n<h3>What's Changed</h3>\n<ul>\n<li><strong>feat(plugin)</strong>: Add <code>assetMaps</code> key to initialContext (<a href=\"https://github.com/ionic-team/ionic-portals/pull/209\">#209</a>)</li>\n</ul>\n",
     "name": "0.7.1",
     "raw_published_at": "2023-03-02T00:05:59Z",
     "published_at": "March 1 2023",
     "tag_name": "0.7.1",
-    "type": "minor",
+    "type": "patch",
     "version": "0.7.1"
+  },
+  {
+    "productTitle": "Portals Web Plugin",
+    "pageUrl": "https://ionic.io/docs/portals/for-web/changelog",
+    "repo": "ionic-team/ionic-portals",
+    "mdBody": "This release upgrades Portals to use Capacitor 4.\n\nTo upgrade from the previous release please reference the [UPGRADE GUIDE](https://ionic.io/docs/portals/for-web/upgrade-guides#portals-web-plugin-06x--070).\n\n### What's Changed\n* **feat**: Update InitialContext ([#184](https://github.com/ionic-team/ionic-portals/pull/184))\n* **feat**: capacitor 4 update ([#187](https://github.com/ionic-team/ionic-portals/pull/187))\n\n",
+    "body": "<p>This release upgrades Portals to use Capacitor 4.</p>\n<p>To upgrade from the previous release please reference the <a href=\"https://ionic.io/docs/portals/for-web/upgrade-guides#portals-web-plugin-06x--070\">UPGRADE GUIDE</a>.</p>\n<h3>What's Changed</h3>\n<ul>\n<li><strong>feat</strong>: Update InitialContext (<a href=\"https://github.com/ionic-team/ionic-portals/pull/184\">#184</a>)</li>\n<li><strong>feat</strong>: capacitor 4 update (<a href=\"https://github.com/ionic-team/ionic-portals/pull/187\">#187</a>)</li>\n</ul>\n",
+    "name": "0.7.0",
+    "raw_published_at": "2022-11-22T16:41:04Z",
+    "published_at": "November 22 2022",
+    "tag_name": "0.7.0",
+    "type": "minor",
+    "version": "0.7.0"
   }
 ]