bitmovin-player-ui 3.53.0 → 3.55.0

package/.github/ISSUE_TEMPLATE/config.yml

@@ -0,0 +1,11 @@
+blank_issues_enabled: false
+contact_links:
+  - name: Report a Bug
+    url: https://dashboard.bitmovin.com/support/tickets
+    about: Report a Bug you encountered in our Bitmovin Player UI in your Bitmovin Customer Dashboard.
+  - name: Feature Requests
+    url: https://community.bitmovin.com/t/how-to-submit-a-feature-request-to-us/1463
+    about: Learn how to suggest new features for our Player SDKs.
+  - name: Report a security vulnerability
+    url: https://bitmovin.atlassian.net/wiki/external/1502085332/YTYwODMwZjQyNjkwNGQ0ODg5MTgwM2NhMDliNjRmODE
+    about: Report a security vulnerability.

package/.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,6 @@
+## Description
+<!-- Add a short description about the changes -->
+
+## Checklist (for PR submitter and reviewers)
+<!-- A PR with CHANGELOG entry will be released automatically -->
+- [ ] `CHANGELOG` entry

package/.github/scripts/notifySlackTeam.js

@@ -0,0 +1,79 @@
+const fs = require('fs');
+const https = require('https');
+
+const jobStatus = process.argv[2];
+const changelogPath = process.argv[3];
+const slackWebhookUrl = process.argv[4];
+const runId = process.argv[5];
+
+const failureSlackChannelId = 'CGRK9DV7H';
+const successSlackChannelId = 'C0LJ16JBS';
+
+fs.readFile(changelogPath, 'utf8', (err, fileContent) => {
+  if (err) {
+    throw err;
+  }
+
+  const changelogContent = parseChangelogEntry(fileContent);
+  const releaseVersion = parseReleaseVersion(fileContent);
+  sendSlackMessage(releaseVersion, changelogContent);
+});
+
+function parseReleaseVersion(fileContent) {
+  const regex = /##\s\[(\d+\.\d+.\d+)\]/;
+  const releaseVersion = fileContent.match(regex);
+
+  return releaseVersion[1];
+}
+
+function parseChangelogEntry(fileContent) {
+  // The regex looks for the first paragraph starting with "###" until it finds
+  // a paragraph starting with "##".
+  // For some reason it also matches 2 chars at the end. With the .slice
+  // those 2 chars get removed from the string.
+  const regex = /###(.)*[\s\S]*?(?=\s##\s\[v*?)/;
+
+  let changelogContent = fileContent.match(regex);
+  changelogContent = changelogContent.slice(0, -1);
+  return changelogContent.toString();
+}
+
+function sendSlackMessage(releaseVersion, changelogContent) {
+  let message;
+  let slackChannelId;
+  if (jobStatus === 'success') {
+    slackChannelId = successSlackChannelId
+    message = `Changelog v${releaseVersion}\n${changelogContent}`
+  } else {
+    slackChannelId = failureSlackChannelId
+    message = `Release v${releaseVersion} failed.\nPlease check https://github.com/bitmovin/bitmovin-player-ui/actions/runs/${runId}`
+  }
+
+  const sampleData = JSON.stringify({
+    "channel": slackChannelId,
+    "message": message
+  });
+  const options = {
+    method: 'POST',
+    headers: {
+      'Content-Type': 'application/json',
+      'Accept': "application/json",
+    }
+  };
+
+  var req = https.request(slackWebhookUrl, options, (res) => {
+    console.log('statusCode:', res.statusCode);
+    console.log('headers:', res.headers);
+  
+    res.on('data', (d) => {
+      process.stdout.write(d);
+    });
+  });
+  
+  req.on('error', (e) => {
+    console.error(e);
+  });
+  
+  req.write(sampleData);
+  req.end();
+}

package/.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;

package/.github/workflows/release.yml

@@ -16,7 +16,9 @@ jobs:
 
     steps:
       - name: Checkout
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
+        with:
+          ref: develop
 
       - uses: actions/download-artifact@v3
         with:
@@ -32,3 +34,19 @@ jobs:
         env:
           NPM_DRY_RUN: false
           NPM_AUTH_TOKEN: ${{ secrets.NPM_AUTH_TOKEN }}
+
+      - name: Notify team
+        run: node .github/scripts/notifySlackTeam.js 'success' 'CHANGELOG.md' ${{ secrets.RELEASE_SUCCESS_SLACK_WEBHOOK }}
+
+  handle_failure:
+    runs-on: ubuntu-latest
+    needs: [test_and_build, download_and_publish]
+    if: ${{ always() && (needs.download_and_publish.result == 'failure' || needs.test_and_build.result == 'failure') }}
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+        with:
+          ref: develop
+
+      - name: Notify team
+        run: node .github/scripts/notifySlackTeam.js 'failure' 'CHANGELOG.md' ${{ secrets.RELEASE_FAILURE_SLACK_WEBHOOK }} ${{ github.run_id }}

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

@@ -13,9 +13,9 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout
-        uses: actions/checkout@v2
+        uses: actions/checkout@v4
         with:
-          token: ${{ secrets.RELEASE_DEPLOY_KEY }}
+          ssh-key: ${{ secrets.RELEASE_DEPLOY_KEY }}
           ref: develop
 
       - name: Install dependencies
@@ -68,3 +68,7 @@ jobs:
           git commit -m "Add release date to changelog"
           git push origin develop
           git push origin --tags
+
+      - name: Notify failure
+        if: ${{ failure() }}
+        run: node .github/scripts/notifySlackTeam.js 'failure' 'CHANGELOG.md' ${{ secrets.RELEASE_FAILURE_SLACK_WEBHOOK }} ${{ github.run_id }}

package/CHANGELOG.md

@@ -4,7 +4,21 @@ 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/).
 
-## [develop]
+## [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
+- FCC subtitle settings menu showing two options with the same value
+- Invalid release workflow file
+
+## [3.53.0] - 2024-01-03
 
 ### Added
 - Automate release on every PR merge to develop
@@ -892,6 +906,9 @@ 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.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