chore: linked versions for player, video, audio, uploader (#1054)

we can easily sync the custom element and react versions now with this release please plugin.
muxinc · Dec 20, 2024 · 2925c6b · 2925c6b
1 parent dd4264d
commit 2925c6b
Show file tree

Hide file tree

Showing 3 changed files with 28 additions and 12 deletions.
diff --git a/.github/release-please/release-please-config.json b/.github/release-please/release-please-config.json
@@ -4,7 +4,32 @@
   "tag-separator": "@",
   "include-component-in-tag": true,
   "include-v-in-tag": false,
-  "plugins": ["node-workspace"],
+  "plugins": [
+    {
+      "type": "node-workspace",
+      "merge": false
+    },
+    {
+      "type": "linked-versions",
+      "groupName": "player",
+      "components": ["@mux/mux-player", "@mux/mux-player-react"]
+    },
+    {
+      "type": "linked-versions",
+      "groupName": "audio",
+      "components": ["@mux/mux-audio", "@mux/mux-audio-react"]
+    },
+    {
+      "type": "linked-versions",
+      "groupName": "video",
+      "components": ["@mux/mux-video", "@mux/mux-video-react"]
+    },
+    {
+      "type": "linked-versions",
+      "groupName": "uploader",
+      "components": ["@mux/mux-uploader", "@mux/mux-uploader-react"]
+    }
+  ],
   "packages": {
     "packages/mux-active-viewer-count": {
       "component": "@mux/mux-active-viewer-count",

diff --git a/README.md b/README.md
@@ -22,8 +22,8 @@ Elements are written to make it easy to work in a variety of web frameworks. If
 | [mux-video-react](packages/mux-video-react)                 | Mux React video component          | React         | Public Beta             |
 | [mux-audio](packages/mux-audio)                             | Mux HTML5 audio element            | Web Component | Public Beta             |
 | [mux-audio-react](packages/mux-audio-react)                 | Mux HTML5 audio component          | React         | Public Beta             |
-| [mux-player](packages/mux-player)                           | Mux HTML5 media player component   | Web Component | 2.x.x 🎉                |
-| [mux-player-react](packages/mux-player-react)               | Mux React media player component   | React         | 2.x.x 🎉                |
+| [mux-player](packages/mux-player)                           | Mux HTML5 media player component   | Web Component | 3.x.x 🎉                |
+| [mux-player-react](packages/mux-player-react)               | Mux React media player component   | React         | 3.x.x 🎉                |
 | [mux-uploader](packages/mux-uploader)                       | Mux HTML5 media uploader component | Web Component | 1.x.x 🎉                |
 | [mux-uploader-react](packages/mux-uploader-react)           | Mux React media uploader component | React         | 1.x.x 🎉                |
 | [mux-active-viewer-count](packages/mux-active-viewer-count) | Mux HTML5 viewer count component   | Web Component | Public Alpha            |

diff --git a/README_INTERNAL.md b/README_INTERNAL.md
@@ -25,15 +25,6 @@ To run tests for the entire monorepo, run `yarn test` from the monorepo root. In
   - **NOTE**: This is only available for core contributors and requires `SAUCE_USERNAME` + `SAUCE_ACCESS_KEY` env variables setup. Reach out to relevant team members for assistance.
   - **NOTE**: Currently only implemented for the `mux-player` package.
 
-## Validating how your changes will affect version updates
-
-You can do a dry-run locally of the `version:update` script by doing the following:
-
-1. Create a new branch from `main`
-2. Cherry pick commits from your working branch to it, including any needed footer e.g. "BREAKING CHANGE: ..."
-3. Push new branch to remote
-4. Run the script `yarn version:update` and select 'n' (no) for committing to the changes
-
 # Media Chrome Canaries
 
 It's helpful to point at Media Chrome canaries for developing PRs and having all the live examples work; however, we should not merge any PRs that point at a Media Chrome Canary release.