diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml index 892b42f2..ae4c71f0 100644 --- a/.github/workflows/release.yml +++ b/.github/workflows/release.yml @@ -11,6 +11,9 @@ jobs: # Checks-out your repository under $GITHUB_WORKSPACE, so your job can access it - name: Checkout uses: actions/checkout@v3 + with: + ssh-key: ${{ secrets.RELEASE_DEPLOY_KEY }} + ref: develop # The Yospace private npm registry seems to not support NPM token so we sadly need to use password and email - name: Log in to Yospace private NPM registry @@ -51,21 +54,28 @@ jobs: const { defineReleaseVersion } = require('./.github/scripts/defineVersion.js') return defineReleaseVersion({core}, "${{ steps.read-latest-release-version.outputs.latestReleaseVersion }}", './CHANGELOG.md' ) - - name: Bump package.json and Changelog version and tag commit + - name: Bump package.json and Changelog version run: | - git config --global user.name 'Automated Release' - git config --global user.email 'release-automation@bitmovin.com' - npm version "${{ fromJson(steps.define-release-version.outputs.result) }}" + npm --no-git-tag-version version "${{ fromJson(steps.define-release-version.outputs.result) }}" npx kacl release - - name: Push changes + - name: Add tag and push changes run: | + git config --global user.name 'Automated Release' + git config --global user.email 'release-automation@bitmovin.com' git add . git commit -m "Bump version and update changelog" + git tag -a "${{ fromJson(steps.define-release-version.outputs.result) }}" -m "v${{ fromJson(steps.define-release-version.outputs.result) }}" git push origin develop git push origin --tags - name: build and publish run: | echo "//registry.npmjs.org/:_authToken=${{ secrets.NPM_AUTH_TOKEN }}" > ~/.npmrc - npm run publish + npm publish + + - name: Create GitHub release + uses: softprops/action-gh-release@v2 + with: + generate_release_notes: true + tag_name: ${{ fromJson(steps.define-release-version.outputs.result) }} diff --git a/CHANGELOG.md b/CHANGELOG.md index 6e3d2099..87ff51a4 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -7,6 +7,12 @@ and this project adheres to [Semantic Versioning](http://semver.org/). ## [Unreleased] +### Fixed + +- Parsing non-Yospace ID3 tags and passing those to the Yospace SDK + +## [2.5.0] - 2024-07-10 + ### Added - `mode` argument to `getCurrentTime` to enable fetching absolute time including ad durations @@ -41,26 +47,32 @@ and this project adheres to [Semantic Versioning](http://semver.org/). - ad immunity events to `YospacePlayerEvent` enum +## [2.4.0] - 2024-06-21 + +### Added + +- `mode` argument to `getCurrentTime` to enable fetching absolute time including ad durations +- `mode` argument to `getDuration` to enable fetching absolute duration including ad durations + ### Fixed - Event loop on pre-roll ad end - Bitmovin Player getting bundled into the YospaceBitmovinPlayer -- Parsing non-Yospace ID3 tags and passing those to the Yospace SDK -## 2.3.1 - 2024-02-14 +## [2.3.1] - 2024-02-14 ### Removed - Node "16.15.1" engines requirement from npm package. -## 2.3.0 - 2023-05-02 +## [2.3.0] - 2023-05-02 ### Changed - Yospace SDK to v3.6.0 - Bitmovin Player to version [8.114.0](https://developer.bitmovin.com/playback/docs/release-notes-web#81140) -## 2.2.0 - 2023-02-09 +## [2.2.0] - 2023-02-09 ### Added @@ -72,13 +84,13 @@ and this project adheres to [Semantic Versioning](http://semver.org/). - Yospace Error code `HLS_SOURCE_MISSING` (1010) has now been deprecated in favor of `SUPPORTED_SOURCE_MISSING` (1012) -## 2.1.0 - 2022-10-20 +## [2.1.0] - 2022-10-20 ### Added - Support for `EMSG` v1 metadata with scheme ID `https://aomedia.org/emsg/ID3` -## 2.0.0 - 2022-07-06 +## [2.0.0] - 2022-07-06 ### Added @@ -113,7 +125,7 @@ and this project adheres to [Semantic Versioning](http://semver.org/). - `setup` method - unregistering all ServiceWorkers in the setup flow -## 1.2.25 - 2021-09-03 +## [1.2.25] - 2021-09-03 ### Added @@ -123,7 +135,11 @@ and this project adheres to [Semantic Versioning](http://semver.org/). - Sequential VPAIDs sometimes getting skipped on VOD assets -## 1.2.24 - 2021-08-19 +## [1.2.24] - 2021-08-19 + +### Added + +- YospaceConfig parameter `vpaidStaticVastXmlOverride` for overriding VPAID xml files for testing ### Changed @@ -135,11 +151,7 @@ and this project adheres to [Semantic Versioning](http://semver.org/). - Bitmovin Ad Module error when encountering AdVerifications in nested Extension - Playback occasionally freezing on Tizen when switching periods/discontinuities -### Added - -- YospaceConfig parameter `vpaidStaticVastXmlOverride` for overriding VPAID xml files for testing - -## 1.2.23 - 2021-06-23 +## [1.2.23] - 2021-06-23 ### Added @@ -152,13 +164,13 @@ and this project adheres to [Semantic Versioning](http://semver.org/). - Tizen Demo Updates for latest SmartTv Convig params in YospaceConfig -## 1.2.22 - 2021-05-10 +## [1.2.22] - 2021-05-10 ### Changed - Add Tizen and WebOS Bitmovin Modules -## 1.2.21 - 2021-03-03 +## [1.2.21] - 2021-03-03 ### Changed @@ -166,7 +178,16 @@ and this project adheres to [Semantic Versioning](http://semver.org/). to the correct player based on source. - Note: This change required updating to TypeScript version 3. -## 1.2.20-2 - 2021-07-28 +## [1.2.20] - 2021-02-12 + +### Fixed + +- Remove the [arrayAccessForm](https://github.com/x2js/x2js/blob/development/x2js.d.ts#L116), config option from `X2JS` + initialization for parsing VAST Extensions. This was causing unpredictable arrays for + the `Extension.CreativeParameters` property. Without the option, it consistently returns an object when there is only + one `CreativeParameter` property. + +## [1.2.20-2] - 2021-07-28 ### Added @@ -176,28 +197,14 @@ and this project adheres to [Semantic Versioning](http://semver.org/). - Additional Quartile beacons fired at the end of playback for some Ads -## 1.2.20-1 - 2021-07-19 +## [1.2.20-1] - 2021-07-19 ### Fixed - Duplicate `defaultImpression` events fired for VPAID pre-rolls - VPAID pre-roll stuttering -## 1.2.20 - 2021-02-12 - -### Fixed - -- Remove the [arrayAccessForm](https://github.com/x2js/x2js/blob/development/x2js.d.ts#L116), config option from `X2JS` - initialization for parsing VAST Extensions. This was causing unpredictable arrays for - the `Extension.CreativeParameters` property. Without the option, it consistently returns an object when there is only - one `CreativeParameter` property. - -## 1.2.19 - 2021-01-20 - -### Fixed - -- Added a temporary fix for a bug on Safari mobile that results in duplicate ad events from Yospace, as a result of - incorrect Position updates reported to the YS SDK. +## [1.2.19] - 2021-01-20 ### Added @@ -208,20 +215,25 @@ and this project adheres to [Semantic Versioning](http://semver.org/). - Use `session.getCurrentBreak()` for the `ads.getCurrentAdBreak()` - Refactor `CreateAdBreakEvent` to take a `YospaceAdBreakEvent`. -## 1.2.18 - 2020-12-09 +### Fixed + +- Added a temporary fix for a bug on Safari mobile that results in duplicate ad events from Yospace, as a result of + incorrect Position updates reported to the YS SDK. + +## [1.2.18] - 2020-12-09 ### Changed - Update `bitmovin-player` to version `8.50.0` - Remove suppression of `AdClicked` event so it can be consumed by integrators for VPAID ads. -## 1.2.17 - 2020-11-12 +## [1.2.17] - 2020-11-12 ### Changed - Update `bitmovin-player` to version `8.48.2` -## 1.2.16 - 2020-10-24 +## [1.2.16] - 2020-10-24 ### Changed @@ -232,26 +244,26 @@ and this project adheres to [Semantic Versioning](http://semver.org/). - Type error in `onVpaidAdBreakStarted` event handler. - Correct expected format for `staticResource` in companion ad. Per section 3.15.1 of the VAST Spec. -## 1.2.15 - 2020-10-16 +## [1.2.15] - 2020-10-16 ### Added - Emit `metadataParsed` and `metadata` events for generated EMSG/ID3 tags in the DateRangeEmitter. - Support for companion ads that have multiple `variations`. -## 1.2.14 - 2020-10-01 +## [1.2.14] - 2020-10-01 ### Changed - Update `bitmovin-player` to version `8.45.1` -## 1.2.13 - 2020-07-10 +## [1.2.13] - 2020-07-10 ### Changed - Update `bitmovin-player` to version `8.39.0` -## 1.2.12 - 2020-06-18 +## [1.2.12] - 2020-06-18 ### Changed @@ -262,19 +274,19 @@ and this project adheres to [Semantic Versioning](http://semver.org/). - Suppress Yospace Analytics before sending the Pause event at the start of a VPAID, per Yospace recommendation. - Remove `-2` adjustment to `replaceContentDuration` for Truex VPAID ads, as seeking logic is handled in TUB. -## 1.2.11 - 2020-05-27 +## [1.2.11] - 2020-05-27 ### Changed - Upgrade to `bitmovin-player` version `8.35.1`. Same functionality as the beta mentioned below. -## 1.2.10 - 2020-05-22 +## [1.2.10] - 2020-05-22 ### Changed - Upgrade `bitmovin-player` to version `8.35.1-b.1` which resolves issues with parsing Closed Captions. -## 1.2.9 - 2020-05-14 +## [1.2.9] - 2020-05-14 ### Added @@ -289,44 +301,44 @@ and this project adheres to [Semantic Versioning](http://semver.org/). - Remove code to destroy both players as it was causing an exception and not needed. -## 1.2.8 - 2020-05-07 +## [1.2.8] - 2020-05-07 ### Added - Expose `YospaceAdBreak` and `YospaceAdBreakEvent` interfaces for use by integrators. -## 1.2.7 - 2020-05-01 +## [1.2.7] - 2020-05-01 ### Changed - Bump `bitmovin-player` to version `8.34.0` -## 1.2.6 - 2020-04-22 +## [1.2.6] - 2020-04-22 ### Fixed - When the `disableServiceWorker` flag is set to true, don't make calls to `navigator.serviceWorker.getRegistrations()`. This was causing issues on Tizen devices. -## 1.2.5 - 2020-04-15 +## [1.2.5] - 2020-04-15 ### Changed - Bump `bitmovin-player` to version `8.33.0` -## 1.2.4 - 2020-04-06 +## [1.2.4] - 2020-04-06 ### Changed - Revert `isLive()` method to return response from `player.isLive()`. Only use `isLiveStream` when cleaning up VPAID. -## 1.2.3 - 2020-03-27 +## [1.2.3] - 2020-03-27 ### Changed - Downgrade Bitmovin Web SDK to 8.29.1 because of issues found with transitioning out of VPAID Ads. -## 1.2.2 - 2020-03-19 +## [1.2.2] - 2020-03-19 ### Changed @@ -335,7 +347,7 @@ and this project adheres to [Semantic Versioning](http://semver.org/). - Update Bitmovin Web SDK to 08.31.0 - `player.isLive()` returns false when in a VPAID, so store `isLiveStream` in a variable upon playing the stream. -## 1.2.0 - 2020-03-03 +## [1.2.0] - 2020-03-03 ### Added @@ -350,7 +362,7 @@ and this project adheres to [Semantic Versioning](http://semver.org/). - Updated Bitmovin Web SDK to 8.30.0 - Fire a new `TruexAdBreakFinished` event -## 1.1.0 - 2020-02-18 +## [1.1.0] - 2020-02-18 ### Changed @@ -361,3 +373,40 @@ and this project adheres to [Semantic Versioning](http://semver.org/). ### Added - Initial yospace integration + +[unreleased]: https://github.com/bitmovin/bitmovin-player-web-integrations-yospace/compare/v2.5.0...HEAD +[2.5.0]: https://github.com/bitmovin/bitmovin-player-web-integrations-yospace/compare/v2.4.0...v2.5.0 +[2.4.0]: https://github.com/bitmovin/bitmovin-player-web-integrations-yospace/compare/v2.3.1...v2.4.0 +[2.3.1]: https://github.com/bitmovin/bitmovin-player-web-integrations-yospace/compare/v2.3.0...v2.3.1 +[2.3.0]: https://github.com/bitmovin/bitmovin-player-web-integrations-yospace/compare/v2.2.0...v2.3.0 +[2.2.0]: https://github.com/bitmovin/bitmovin-player-web-integrations-yospace/compare/v2.1.0...v2.2.0 +[2.1.0]: https://github.com/bitmovin/bitmovin-player-web-integrations-yospace/compare/v2.0.0...v2.1.0 +[2.0.0]: https://github.com/bitmovin/bitmovin-player-web-integrations-yospace/compare/v1.2.25...v2.0.0 +[1.2.25]: https://github.com/bitmovin/bitmovin-player-web-integrations-yospace/compare/v1.2.24...v1.2.25 +[1.2.24]: https://github.com/bitmovin/bitmovin-player-web-integrations-yospace/compare/v1.2.23...v1.2.24 +[1.2.23]: https://github.com/bitmovin/bitmovin-player-web-integrations-yospace/compare/v1.2.22...v1.2.23 +[1.2.22]: https://github.com/bitmovin/bitmovin-player-web-integrations-yospace/compare/v1.2.21...v1.2.22 +[1.2.21]: https://github.com/bitmovin/bitmovin-player-web-integrations-yospace/compare/v1.2.20...v1.2.21 +[1.2.20]: https://github.com/bitmovin/bitmovin-player-web-integrations-yospace/compare/v1.2.20-2...v1.2.20 +[1.2.20-2]: https://github.com/bitmovin/bitmovin-player-web-integrations-yospace/compare/v1.2.20-1...v1.2.20-2 +[1.2.20-1]: https://github.com/bitmovin/bitmovin-player-web-integrations-yospace/compare/v1.2.19...v1.2.20-1 +[1.2.19]: https://github.com/bitmovin/bitmovin-player-web-integrations-yospace/compare/v1.2.18...v1.2.19 +[1.2.18]: https://github.com/bitmovin/bitmovin-player-web-integrations-yospace/compare/v1.2.17...v1.2.18 +[1.2.17]: https://github.com/bitmovin/bitmovin-player-web-integrations-yospace/compare/v1.2.16...v1.2.17 +[1.2.16]: https://github.com/bitmovin/bitmovin-player-web-integrations-yospace/compare/v1.2.15...v1.2.16 +[1.2.15]: https://github.com/bitmovin/bitmovin-player-web-integrations-yospace/compare/v1.2.14...v1.2.15 +[1.2.14]: https://github.com/bitmovin/bitmovin-player-web-integrations-yospace/compare/v1.2.13...v1.2.14 +[1.2.13]: https://github.com/bitmovin/bitmovin-player-web-integrations-yospace/compare/v1.2.12...v1.2.13 +[1.2.12]: https://github.com/bitmovin/bitmovin-player-web-integrations-yospace/compare/v1.2.11...v1.2.12 +[1.2.11]: https://github.com/bitmovin/bitmovin-player-web-integrations-yospace/compare/v1.2.10...v1.2.11 +[1.2.10]: https://github.com/bitmovin/bitmovin-player-web-integrations-yospace/compare/v1.2.9...v1.2.10 +[1.2.9]: https://github.com/bitmovin/bitmovin-player-web-integrations-yospace/compare/v1.2.8...v1.2.9 +[1.2.8]: https://github.com/bitmovin/bitmovin-player-web-integrations-yospace/compare/v1.2.7...v1.2.8 +[1.2.7]: https://github.com/bitmovin/bitmovin-player-web-integrations-yospace/compare/v1.2.6...v1.2.7 +[1.2.6]: https://github.com/bitmovin/bitmovin-player-web-integrations-yospace/compare/v1.2.5...v1.2.6 +[1.2.5]: https://github.com/bitmovin/bitmovin-player-web-integrations-yospace/compare/v1.2.4...v1.2.5 +[1.2.4]: https://github.com/bitmovin/bitmovin-player-web-integrations-yospace/compare/v1.2.3...v1.2.4 +[1.2.3]: https://github.com/bitmovin/bitmovin-player-web-integrations-yospace/compare/v1.2.2...v1.2.3 +[1.2.2]: https://github.com/bitmovin/bitmovin-player-web-integrations-yospace/compare/v1.2.0...v1.2.2 +[1.2.0]: https://github.com/bitmovin/bitmovin-player-web-integrations-yospace/compare/v1.1.0...v1.2.0 +[1.1.0]: https://github.com/bitmovin/bitmovin-player-web-integrations-yospace/compare/v1.0.0...v1.1.0 diff --git a/package-lock.json b/package-lock.json index ba6debfc..f7046614 100644 --- a/package-lock.json +++ b/package-lock.json @@ -1,12 +1,12 @@ { "name": "@bitmovin/player-integration-yospace", - "version": "2.4.0-rc.1", + "version": "2.5.0", "lockfileVersion": 2, "requires": true, "packages": { "": { "name": "@bitmovin/player-integration-yospace", - "version": "2.4.0-rc.1", + "version": "2.5.0", "license": "MIT", "dependencies": { "@yospace/admanagement-sdk": "3.6.9", diff --git a/package.json b/package.json index 01ecbe86..7ad66fc9 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "@bitmovin/player-integration-yospace", - "version": "2.4.0-rc.1", + "version": "2.5.0", "description": "Yospace integration for the Bitmovin Player", "main": "./dist/js/bitmovin-player-yospace.js", "types": "./dist/js/main.d.ts",