Merge branch 'develop' into 28277-spatial-action-on-no-focus

Author: oberhamsi

.github/scripts/notifySlackTeam.js

@@ -1,5 +1,6 @@
 const fs = require('fs');
 const https = require('https');
+const { parseChangelogEntry } = require('./parseChangelogEntry.js');
 
 const versionNumber = process.argv[2];
 const jobStatus = process.argv[3];
@@ -10,32 +11,32 @@ const runId = process.argv[6];
 const failureSlackChannelId = 'CGRK9DV7H';
 const successSlackChannelId = 'C0LJ16JBS';
 
-fs.readFile(changelogPath, 'utf8', (err, fileContent) => {
-  if (err) {
-    throw err;
-  }
-
-  const changelogContent = parseChangelogEntry(fileContent);
-  sendSlackMessage(versionNumber, changelogContent);
-});
-
+if (jobStatus !== 'success') {
+  sendSlackMessage(versionNumber, '');
+} else {
+  fs.readFile(changelogPath, 'utf8', (err, fileContent) => {
+    if (err) {
+      throw err;
+    }
 
-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;
+    try {
+      changelogContent = parseChangelogEntry(fileContent);
+    } catch (parseError) {
+      console.error(`Failed to parse the latest changelog entry for v${versionNumber}.`, parseError);
+      changelogContent =
+        `Changelog details could not be extracted automatically for v${versionNumber}. ` +
+        'Please check CHANGELOG.md in the release tag.';
+    }
 
-  let changelogContent = fileContent.match(regex);
-  changelogContent = changelogContent.slice(0, -1);
-  return changelogContent.toString();
+    sendSlackMessage(versionNumber, changelogContent);
+  });
 }
 
 function sendSlackMessage(releaseVersion, changelogContent) {
   const slackChannelId = jobStatus === 'success' ? successSlackChannelId : failureSlackChannelId;
   const generalPayload = {
-    channel: slackChannelId
+    channel: slackChannelId,
   };
 
   let payload;
@@ -63,7 +64,7 @@ function sendSlackMessage(releaseVersion, changelogContent) {
           ],
         },
       ],
-    }
+    };
   } else {
     payload = {
       ...generalPayload,
@@ -76,31 +77,31 @@ function sendSlackMessage(releaseVersion, changelogContent) {
           text: `Please check the <https://github.com/bitmovin/bitmovin-player-ui/actions/runs/${runId}|failed run>`,
         },
       ],
-    }
+    };
   }
 
   const sampleData = JSON.stringify(payload);
   const options = {
     method: 'POST',
     headers: {
       'Content-Type': 'application/json',
-      'Accept': "application/json",
-    }
+      Accept: 'application/json',
+    },
   };
 
-  var req = https.request(slackWebhookUrl, options, (res) => {
+  var req = https.request(slackWebhookUrl, options, res => {
     console.log('statusCode:', res.statusCode);
     console.log('headers:', res.headers);
-  
-    res.on('data', (d) => {
+
+    res.on('data', d => {
       process.stdout.write(d);
     });
   });
-  
-  req.on('error', (e) => {
+
+  req.on('error', e => {
     console.error(e);
   });
-  
+
   req.write(sampleData);
   req.end();
 }

.github/scripts/parseChangelogEntry.js

@@ -0,0 +1,18 @@
+/**
+ * Extracts the first (latest) changelog entry from a changelog string.
+ *
+ * @param {string} changelogContent - The full changelog file content
+ * @returns {string} The changelog entry content (without the ## heading)
+ * @throws {Error} If no changelog entry is found
+ */
+function parseChangelogEntry(changelogContent) {
+  const match = changelogContent.match(/## \[[\s\S]*?(?=\n## |$)/);
+
+  if (!match) {
+    throw new Error('No changelog entry found');
+  }
+
+  return match[0].replace(/^## .*\n/, '').trim();
+}
+
+module.exports.parseChangelogEntry = parseChangelogEntry;

.github/workflows/ci.yml

@@ -4,16 +4,34 @@ on:
   push:
     branches:
       - '**'
-
+  pull_request:
   workflow_call:
 
 concurrency:
-  group: ${{ github.event_name == 'workflow_call' && format('release-ci-{0}', github.run_id) || format('ci-{0}', github.ref) }}
+  group: ${{ github.event_name == 'workflow_call' && format('ci-{0}', github.run_id) || format('ci-{0}', github.ref) }}
   cancel-in-progress: true
 
 jobs:
+  gate:
+    name: Gate
+    runs-on: ubuntu-latest
+    outputs:
+      should_run: ${{ steps.eval.outputs.should_run }}
+    steps:
+      - id: eval
+        run: |
+          if [[ "${{ github.event_name }}" == "push" ]] || [[ "${{ github.event_name }}" == "workflow_call" ]]; then
+            echo "should_run=true" >> "$GITHUB_OUTPUT"
+          elif [[ "${{ github.event_name }}" == "pull_request" && "${{ github.event.pull_request.head.repo.full_name }}" != "${{ github.repository }}" ]]; then
+            echo "should_run=true" >> "$GITHUB_OUTPUT"
+          else
+            echo "should_run=false" >> "$GITHUB_OUTPUT"
+          fi
+
   test:
     name: Test
+    needs: gate
+    if: needs.gate.outputs.should_run == 'true'
     runs-on: ubuntu-latest
 
     steps:
@@ -28,6 +46,8 @@ jobs:
 
   build:
     name: Build
+    needs: gate
+    if: needs.gate.outputs.should_run == 'true'
     runs-on: ubuntu-latest
 
     steps:
@@ -42,6 +62,8 @@ jobs:
 
   lint:
     name: Lint
+    needs: gate
+    if: needs.gate.outputs.should_run == 'true'
     runs-on: ubuntu-latest
 
     steps:

.github/workflows/release.yml

@@ -55,6 +55,9 @@ on:
       RELEASE_DEPLOY_KEY:
         description: 'SSH deploy key with write access to the repository'
         required: true
+      GCS_BUCKET:
+        description: 'Google Cloud Storage bucket name for uploading docs'
+        required: true
 
 concurrency:
   group: release-${{ inputs.version_number }}-${{ inputs.release_type }}
@@ -143,7 +146,7 @@ jobs:
         run: |
           git config --global user.name 'Automated Release'
           git config --global user.email 'release-automation@bitmovin.com'
-          git add package.json CHANGELOG.md
+          git add package.json package-lock.json CHANGELOG.md
           git commit -m "[skip ci] Bump version to ${{ steps.version_number.outputs.version_number }}"
           git tag "${{ steps.version_number.outputs.tag_name }}"
           git push origin ${{ inputs.branch_name || github.ref_name }}
@@ -172,6 +175,42 @@ jobs:
         env:
           NPM_AUTH_TOKEN: ${{ secrets.NPM_AUTH_TOKEN }}
 
+  github_release:
+    name: Create GitHub Release
+    needs: [version_bump, release]
+    if: inputs.release_type == 'final' && inputs.dry_run != true
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+        with:
+          ref: ${{ needs.version_bump.outputs.tag_name }}
+
+      - name: Extract changelog entry
+        uses: actions/github-script@v6
+        id: changelog
+        with:
+          script: |
+            const fs = require('fs');
+            const { parseChangelogEntry } = require('./.github/scripts/parseChangelogEntry.js');
+            const version = '${{ needs.version_bump.outputs.version_number }}';
+            const changelog = fs.readFileSync('CHANGELOG.md', 'utf8');
+            let body;
+
+            try {
+              body = parseChangelogEntry(changelog);
+            } catch (error) {
+              core.warning(`Failed to extract release notes for v${version}: ${error.message}`);
+              body = `Release notes are not available for v${version}. Please check CHANGELOG.md in this tag.`;
+            }
+
+            fs.writeFileSync('release_notes.md', body);
+
+      - name: Create GitHub Release
+        run: gh release create "${{ needs.version_bump.outputs.tag_name }}" --title "v${{ needs.version_bump.outputs.version_number }}" --notes-file release_notes.md
+        env:
+          GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+
   upload_docs:
     name: Build and upload Documentation
     needs: [test, version_bump, release]
@@ -211,9 +250,9 @@ jobs:
 
   notify_success:
     name: Notify Success
-    needs: [test, version_bump, release, upload_docs]
+    needs: [test, version_bump, release, upload_docs, github_release]
     runs-on: ubuntu-latest
-    if: inputs.dry_run != true
+    if: ${{ always() && inputs.dry_run != true && needs.test.result == 'success' && needs.version_bump.result == 'success' && needs.release.result == 'success' && needs.upload_docs.result == 'success' && (inputs.release_type != 'final' || needs.github_release.result == 'success') }}
     steps:
       - name: Checkout
         uses: actions/checkout@v4
@@ -226,8 +265,8 @@ jobs:
   handle_failure:
     name: Handle Failure
     runs-on: ubuntu-latest
-    needs: [test, version_bump, release, upload_docs, notify_success]
-    if: ${{ always() && inputs.dry_run != true && (needs.test.result == 'failure' || needs.version_bump.result == 'failure' || needs.release.result == 'failure' || needs.upload_docs.result == 'failure' || needs.notify_success.result == 'failure') }}
+    needs: [test, version_bump, release, upload_docs, github_release, notify_success]
+    if: ${{ always() && inputs.dry_run != true && (needs.test.result == 'failure' || needs.version_bump.result == 'failure' || needs.release.result == 'failure' || needs.upload_docs.result == 'failure' || needs.github_release.result == 'failure' || needs.notify_success.result == 'failure') }}
     steps:
       - name: Checkout
         uses: actions/checkout@v4

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

@@ -1,46 +1,47 @@
-name: Trigger release on merge
-run-name: Starting release for ${{ github.actor }} PR merge
+name: Weekly Release Train
+run-name: Weekly release train ${{ github.event_name == 'workflow_dispatch' && ' (manual)' || '' }}
+
 on:
-  pull_request_target:
-    types:
-      - closed
-    branches:
-      - develop
-      - support/*
+  schedule:
+    - cron: '0 12 * * 4' # Every Thursday at 12:00 UTC
+  workflow_dispatch:
 
 concurrency:
-  group: continuous-deployment-${{ github.event.pull_request.base.ref }}
+  group: weekly-release-train
   cancel-in-progress: true
 
 jobs:
-  verify-changelog:
-    name: Verify that CHANGELOG.md has been updated
-    if: github.event.pull_request.merged == true
-    outputs:
-      HAS_CHANGELOG: ${{ steps.ensure-changelog.outputs.HAS_CHANGELOG }}
+  check-unreleased:
+    name: Check for unreleased changes
     runs-on: ubuntu-latest
+    outputs:
+      has_unreleased: ${{ steps.check.outputs.has_unreleased }}
     steps:
-    - name: Checkout
-      uses: actions/checkout@v4
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Setup dependencies
+        uses: ./.github/actions/setup-dependencies
+
+      - name: Check for unreleased changelog entries
+        uses: actions/github-script@v6
+        id: check
+        with:
+          script: |
+            const { detectReleaseLevel } = require('./.github/scripts/detectReleaseLevel.js');
 
-    - name: Ensure Changelog
-      id: ensure-changelog
-      shell: bash
-      run: |
-        changes=$(gh pr view ${{github.event.pull_request.number}} --json files -q '.files[].path')
-        if echo $changes | grep -q CHANGELOG.md; then
-          echo "CHANGELOG.md has been updated"
-          echo "HAS_CHANGELOG=true" >> $GITHUB_OUTPUT
-        else
-          echo "CHANGELOG.md has not been updated, skipping release"
-        fi
-      env:
-        GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+            try {
+              detectReleaseLevel(core);
+              core.setOutput('has_unreleased', 'true');
+            } catch (error) {
+              core.info(`No unreleased changes found, skipping release: ${error.message}`);
+              core.setOutput('has_unreleased', 'false');
+            }
 
   prepare-version:
     name: Detect and build the version number for the release
-    needs: verify-changelog
-    if: ${{ needs.verify-changelog.outputs.HAS_CHANGELOG }}
+    needs: check-unreleased
+    if: needs.check-unreleased.outputs.has_unreleased == 'true'
     outputs:
       version_number: ${{ steps.define-release-version.outputs.version_number }}
     runs-on: ubuntu-latest
@@ -65,7 +66,7 @@ jobs:
         with:
           script: |
             const { detectReleaseLevel } = require('./.github/scripts/detectReleaseLevel.js');
-            
+
             try {
               const releaseLevel = detectReleaseLevel(core);
               core.setOutput('release_level', releaseLevel);
@@ -82,7 +83,7 @@ jobs:
             const { defineReleaseVersion } = require('./.github/scripts/defineVersion.js');
             const releaseLevel = '${{ steps.detect-release-level.outputs.release_level }}';
             const currentVersion = '${{ steps.define-package-json-version.outputs.packageJsonVersion }}';
-            
+
             const result = defineReleaseVersion({core}, releaseLevel, currentVersion);
             core.setOutput('version_number', result.full);
 
@@ -93,8 +94,10 @@ jobs:
     with:
       version_number: ${{ needs.prepare-version.outputs.version_number }}
       release_type: final
-      branch_name: ${{ github.event.pull_request.base.ref }}
+      branch_name: develop
     secrets:
       NPM_AUTH_TOKEN: ${{ secrets.NPM_AUTH_TOKEN }}
       GCS_CREDENTIALS: ${{ secrets.GCS_CREDENTIALS }}
       SLACK_WEBHOOK_URL: ${{ secrets.SLACK_WEBHOOK_URL }}
+      RELEASE_DEPLOY_KEY: ${{ secrets.RELEASE_DEPLOY_KEY }}
+      GCS_BUCKET: ${{ secrets.GCS_BUCKET }}