Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore!: combine into single media-stream-library package #1085

Merged
merged 1 commit into from
Jan 12, 2025
Merged

Conversation

steabert
Copy link
Member

Moves the overlay, player, and streams modules into the media-stream-library package, but as separate exports. This simplifies package management and moves the two smaller related packages into the main package.

Improves to the way releases work:

  • Always have the package version changed when any changes are made to the source, and add a verification for this (housekeeping job).
  • Release using a workflow trigger, takes the package as it is and creates both a GitHub release and publishes to NPM, using the version already contained in the source.
  • Keep the minified bundle that includes the dependencies outside of the dist folder (thereby excluding it from the NPM package). Since that bundle is only needed outside of a package system, and then we don't need to export it separately.

BREAKING CHANGES:

  • media-overlay-library and media-stream-player packages are no longer provided, they are now available from media-stream-library/overlay and media-stream-library/player respectively.
  • The format of the minified bundles is changed from IIFE to ES module, since this now has baseline support across all modern browsers.

Together these changes allow for simple release flow, where we can just pick latest main for releases, where the correct version is already part of source control.

Checklist for review

  • PR title and description are clear
  • change follows existing coding style and architecture
  • necessary unit tests were added
  • documentation was updated

@steabert steabert requested review from Tigge and rikteg as code owners January 12, 2025 18:47
@steabert steabert force-pushed the release-esm branch 5 times, most recently from 97a70fb to 666c869 Compare January 12, 2025 19:20
Moves the overlay, player, and streams modules into the media-stream-library
package, but as separate exports. This simplifies package management and
moves the two smaller related packages into the main package.

Improves to the way releases work:
- Always have the package version changed when any changes are made
  to the source, and add a verification for this (housekeeping job).
- Release using a workflow trigger, takes the package as it is and
  creates both a GitHub release and publishes to NPM, using the version
  already contained in the source.
- Keep the minified bundle that includes the dependencies outside of
  the dist folder (thereby excluding it from the NPM package). Since
  that bundle is only needed outside of a package system, and then
  we don't need to export it separately.

BREAKING CHANGES:
- `media-overlay-library` and `media-stream-player` packages are no longer
  provided, they are now available from `media-stream-library/overlay` and
  `media-stream-library/player` respectively.
- The format of the minified bundles is changed from IIFE to ES module,
  since this now has baseline support across all modern browsers.

Together these changes allow for simple release flow, where we can
just pick latest main for releases, where the correct version is
already part of source control.
@steabert steabert merged commit a403a88 into main Jan 12, 2025
9 checks passed
@steabert steabert deleted the release-esm branch January 12, 2025 19:26
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant