Merge remote-tracking branch 'origin/develop' into remainingTimeInAdB…

…reakDuration

ensuring branch is up-to-date with develop

.github/PULL_REQUEST_TEMPLATE.md

@@ -3,4 +3,5 @@
 
 ## Checklist (for PR submitter and reviewers)
 <!-- A PR with CHANGELOG entry will be released automatically -->
+<!-- This is required and should be added in every case -->
 - [ ] `CHANGELOG` entry

.github/scripts/updateChangelog.js

@@ -6,12 +6,19 @@
  * @param {string} releaseDate the release date to be written to the changelog
  */
 function updateChangeLog(changelogString, version, releaseDate) {
-    const optionalBetaOrRc = '(-rc.d+)?(-(b|beta).d+)?';
-    const changelogVersionRegExp = new RegExp(
-      `\\[(development|develop|unreleased|${version})${optionalBetaOrRc}.*`,
-      'gi',
-    );
-    return changelogString.replace(changelogVersionRegExp, `[${version}] - ${releaseDate}`);
-  }
-
-  module.exports.updateChangeLog = updateChangeLog;
+  const optionalBetaOrRc = '(-rc.d+)?(-(b|beta).d+)?';
+  const changelogVersionRegExp = new RegExp(
+    `\\[(development|develop|unreleased|${version})${optionalBetaOrRc}.*`,
+    'gi',
+  );
+
+  const lastReleaseVersion = changelogString.match(/## \[(\d+.\d+.\d+)\] - \d{4}-\d{2}-\d{2}/)[1];
+  const changelogWithReleaseVersionAndDate = changelogString.replace(changelogVersionRegExp, `[${version}] - ${releaseDate}`);
+
+  return changelogWithReleaseVersionAndDate.replace(
+    '## 1.0.0 (2017-02-03)\n- First release\n\n',
+    `## 1.0.0 (2017-02-03)\n- First release\n\n[${version}]: https://github.com/bitmovin/bitmovin-player-ui/compare/v${lastReleaseVersion}...v${version}\n`
+  );
+}
+
+module.exports.updateChangeLog = updateChangeLog;

.github/workflows/release.yml

@@ -20,6 +20,17 @@ jobs:
         with:
           ref: develop
 
+      - name: Install dependencies
+        run: npm ci
+
+      - name: Read package.json version
+        uses: actions/github-script@v6
+        id: extract-version
+        with:
+          script: |
+            const { version } = require('./package.json')
+            core.setOutput('packageJsonVersion', version)
+
       - uses: actions/download-artifact@v3
         with:
           path: .
@@ -35,6 +46,27 @@ jobs:
           NPM_DRY_RUN: false
           NPM_AUTH_TOKEN: ${{ secrets.NPM_AUTH_TOKEN }}
 
+      - name: Build documentation
+        run: npx typedoc
+        shell: bash
+
+      - name: Authenticate
+        uses: 'google-github-actions/auth@v2'
+        with:
+          credentials_json: ${{ secrets.GCS_CREDENTIALS }}
+
+      - name: Upload docs
+        uses: 'google-github-actions/upload-cloud-storage@v2'
+        with:
+          path: './docs/'
+          destination: "${{ secrets.GCS_BUCKET }}/player/ui/${{ steps.extract-version.outputs.packageJsonVersion }}"
+
+      - name: Upload docs for major version
+        uses: 'google-github-actions/upload-cloud-storage@v2'
+        with:
+          path: './docs/'
+          destination: "${{ secrets.GCS_BUCKET }}/player/ui/3"
+
       - name: Notify team
         run: node .github/scripts/notifySlackTeam.js 'success' 'CHANGELOG.md' ${{ secrets.RELEASE_SUCCESS_SLACK_WEBHOOK }}
 

.github/workflows/tag-release-version.yml

@@ -1,7 +1,7 @@
 name: Trigger release on merge
 run-name: Starting release for ${{ github.actor }} PR merge
 on:
-  pull_request:
+  pull_request_target:
     types:
       - closed
     branches:

.gitignore

@@ -416,3 +416,4 @@ jspm_packages
 
 # Yarn Integrity file
 .yarn-integrity
+docs

CHANGELOG.md

@@ -4,6 +4,88 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](http://keepachangelog.com/)
 and this project adheres to [Semantic Versioning](http://semver.org/).
 
+## [3.69.0] - 2024-08-14
+### Added
+- API doc generation and publishing. The API doc from the UI can be found [here](https://cdn.bitmovin.com/player/ui/3/docs/index.html)
+
+## [3.67.0] - 2024-07-03
+
+### Added
+- Missing changelog entries of `3.65.0` and `3.66.0` release versions
+
+## [3.66.0] - 2024-07-01
+
+### Changed
+- Playground demo page to include checkbox to enable/disbale ads
+- Store basic configuration of playground demo page in localStorage
+
+## [3.65.0] - 2024-06-24
+
+### Added
+- Eco Mode toggle button
+
+## [3.64.0] - 2024-05-28
+
+### Added
+- `Component` instances are now assigned to their `HTMLElements` for easier accessing
+
+### Fixed
+- Two touch interactions needed to skip an ad or open the click through link
+
+## [3.63.0] - 2024-05-17
+
+### Added
+- `QuickSeekButton` control bar component for jumping +/- a configurable number of seconds (10 second default)
+
+## [3.62.0] - 2024-05-06
+
+### Fixed
+- No subtitle is shown when switching between different tracks
+
+## [3.61.0] - 2024-04-23
+
+### Fixed
+- `ControlBar` not auto-hiding when `UIConfig.disableAutoHideWhenHovered` is set to `true` on some touch screen devices
+
+## [3.60.0] - 2024-04-16
+
+### Added
+- Type export for `UIVariant` interface
+
+## [3.59.0] - 2024-04-12
+
+### Added
+- `UIContainerConfig.hideImmediatelyOnMouseLeave` to immediately hide the UI when mouse leaves it
+
+### Fixed
+- Triggering UI release after merging a PR from a fork
+
+## [3.58.0] - 2024-04-08
+
+### Added
+- `UIConfig#seekbarSnappingEnabled` config option to enable/disable the play head snapping to markers on the seek bar when seeking near them. Default is `true`.
+
+## [3.57.0] - 2024-03-28
+
+### Added
+- `disableStorageApi` config option
+
+### Fixed
+- Subtitle settings not being retained when the UI variant switches
+
+## [3.56.0] - 2024-03-26
+
+### Changed
+- `localStorage` availability check to not create a test-entry anymore
+
+## [3.55.0] - 2024-03-21
+
+### Added
+- Automatically add compare link in changelog file in relase workflow
+
+### Fixed
+- Missing compare link in the changelog file
+
 ## [3.54.0] - 2024-02-01
 
 ### Fixed
@@ -898,6 +980,23 @@ Version 2.0 of the UI framework is built for player 7.1. If absolutely necessary
 ## 1.0.0 (2017-02-03)
 - First release
 
+[3.69.0]: https://github.com/bitmovin/bitmovin-player-ui/compare/v3.67.0...v3.69.0
+[3.68.0]: https://github.com/bitmovin/bitmovin-player-ui/compare/v3.67.0...v3.68.0
+[3.67.0]: https://github.com/bitmovin/bitmovin-player-ui/compare/v3.66.0...v3.67.0
+[3.66.0]: https://github.com/bitmovin/bitmovin-player-ui/compare/v3.65.0...v3.66.0
+[3.65.0]: https://github.com/bitmovin/bitmovin-player-ui/compare/v3.64.0...v3.65.0
+[3.64.0]: https://github.com/bitmovin/bitmovin-player-ui/compare/v3.63.0...v3.64.0
+[3.63.0]: https://github.com/bitmovin/bitmovin-player-ui/compare/v3.62.0...v3.63.0
+[3.62.0]: https://github.com/bitmovin/bitmovin-player-ui/compare/v3.61.0...v3.62.0
+[3.61.0]: https://github.com/bitmovin/bitmovin-player-ui/compare/v3.60.0...v3.61.0
+[3.60.0]: https://github.com/bitmovin/bitmovin-player-ui/compare/v3.59.0...v3.60.0
+[3.59.0]: https://github.com/bitmovin/bitmovin-player-ui/compare/v3.58.0...v3.59.0
+[3.58.0]: https://github.com/bitmovin/bitmovin-player-ui/compare/v3.57.0...v3.58.0
+[3.57.0]: https://github.com/bitmovin/bitmovin-player-ui/compare/v3.56.0...v3.57.0
+[3.56.0]: https://github.com/bitmovin/bitmovin-player-ui/compare/v3.55.0...v3.56.0
+[3.55.0]: https://github.com/bitmovin/bitmovin-player-ui/compare/v3.54.0...v3.55.0
+[3.54.0]: https://github.com/bitmovin/bitmovin-player-ui/compare/v3.53.0...v3.54.0
+[3.53.0]: https://github.com/bitmovin/bitmovin-player-ui/compare/v3.52.2...v3.53.0
 [3.52.2]: https://github.com/bitmovin/bitmovin-player-ui/compare/v3.52.1...v3.52.2
 [3.52.1]: https://github.com/bitmovin/bitmovin-player-ui/compare/v3.52.0...v3.52.1
 [3.52.0]: https://github.com/bitmovin/bitmovin-player-ui/compare/v3.51.0...v3.52.0