Feature Cmcdv2

.github/actions/setup-dashjs/action.yml

@@ -0,0 +1,24 @@
+name: 'Setup dash.js'
+description: 'Setup Node.js, cache and install dependencies'
+
+runs:
+    using: 'composite'
+    steps:
+        -   name: Setup Node.js
+            uses: actions/setup-node@v4
+            with:
+                node-version: '20'
+                cache: 'npm'
+        -   name: Cache node modules
+            id: cache-npm
+            uses: actions/cache@v4
+            with:
+                path: node_modules
+                key: ${{ runner.os }}-build-${{ hashFiles('**/package-lock.json') }}
+                restore-keys: |
+                    ${{ runner.os }}-build-
+                    ${{ runner.os }}-
+        -   name: Install dependencies
+            if: steps.cache-npm.outputs.cache-hit != 'true'
+            shell: bash
+            run: npm install

.github/workflows/deploy.yml

@@ -9,6 +9,10 @@ on:
             deploy_path:
                 required: true
                 type: string
+            deploy_type:
+                required: true
+                type: string
+                description: 'Type of deployment: "samples" (reference player + samples) or "build" (dist artifacts + JSDoc)'
         secrets:
             host:
                 required: true
@@ -23,23 +27,21 @@ jobs:
 
         steps:
             -   uses: actions/checkout@v4
-            -   name: Use Node.js
-                uses: actions/setup-node@v4
-                with:
-                    node-version: "20.x"
-            -   name: Install dependencies
-                run: npm install
+            -   name: Setup dash.js
+                uses: ./.github/actions/setup-dashjs
             -   name: Run build
                 run: npm run build
             -   name: Find and Replace
+                if: inputs.deploy_type == 'samples'
                 uses: jacobtomlinson/gha-find-replace@v2
                 env:
                     replacement_string: ${{ format('{0} - commit <a href="https://github.com/Dash-Industry-Forum/dash.js/commit/{1}">{2}</a>', github.ref_name, github.sha, github.sha)}}
                 with:
                     find: "<!-- commit-info -->"
                     replace: ${{env.replacement_string}}
-                    include: "samples/dash-if-reference-player/index.html"
+                    include: "samples/dash-if-reference-player*/index.html"
             -   name: Build all samples
+                if: inputs.deploy_type == 'samples'
                 run: |
                     for sample in "network-interceptor"; do
                       echo "Building sample: $sample"
@@ -48,16 +50,37 @@ jobs:
                       npm run build
                       rm -rf node_modules
                     done
-            -   name: Copy to deploy directory for deployment
+            -   name: Build JSDoc
+                if: inputs.deploy_type == 'build'
+                run: npm run doc
+                continue-on-error: true
+            -   name: Copy samples to deploy directory
+                if: inputs.deploy_type == 'samples'
+                env:
+                    ENVNAME: ${{ inputs.envname }}
                 run: |
-                    mkdir -p ${{inputs.envname}}
-                    cp -R contrib dist samples ${{inputs.envname}}
+                    mkdir -p "$ENVNAME"
+                    cp -R contrib dist samples "$ENVNAME"
+            -   name: Copy build artifacts to deploy directory
+                if: inputs.deploy_type == 'build'
+                env:
+                    ENVNAME: ${{ inputs.envname }}
+                run: |
+                    mkdir -p "$ENVNAME"
+                    cp -R docs/jsdoc "$ENVNAME/jsdoc" && cp -R dist/modern/umd/* "$ENVNAME" && cp -R dist/* index.d.ts "$ENVNAME"
             -   name: Install SSH Key
                 uses: shimataro/ssh-key-action@v2
                 with:
                     key: ${{ secrets.private_key }}
                     known_hosts: unnecessary
+            -   name: Fetch host keys
+                run: ssh-keyscan -H ${{ secrets.host }} >> ~/.ssh/known_hosts
             -   name: Deploy with scp
+                env:
+                    DEPLOY_USER: ${{ secrets.user }}
+                    DEPLOY_HOST: ${{ secrets.host }}
+                    DEPLOY_PATH: ${{ inputs.deploy_path }}
+                    ENVNAME: ${{ inputs.envname }}
                 run: |
-                    ssh -o StrictHostKeyChecking=no -oHostKeyAlgorithms=+ssh-dss ${{ secrets.USER }}@${{ secrets.HOST }} "mkdir -p ${{ inputs.deploy_path }}/${{inputs.envname}}"
-                    scp -r -o StrictHostKeyChecking=no -oHostKeyAlgorithms=+ssh-dss ${{inputs.envname}} ${{ secrets.user }}@${{ secrets.host }}:${{ inputs.deploy_path }}
+                    ssh "$DEPLOY_USER@$DEPLOY_HOST" "mkdir -p \"$DEPLOY_PATH/$ENVNAME\""
+                    scp -r "$ENVNAME" "$DEPLOY_USER@$DEPLOY_HOST:$DEPLOY_PATH"

.github/workflows/deploy_build_latest.yml

@@ -1,4 +1,4 @@
-name: deploy_latest
+name: deploy_build_latest
 
 on:
     push:
@@ -8,10 +8,11 @@ on:
 jobs:
     deploy_latest:
         if: github.repository == 'Dash-Industry-Forum/dash.js'
-        uses: ./.github/workflows/deploy_build.yml
+        uses: ./.github/workflows/deploy.yml
         with:
             envname: latest
             deploy_path: '/377335'
+            deploy_type: build
         secrets:
             host: ${{secrets.HOST}}
             user: ${{secrets.USER}}

.github/workflows/deploy_build_latest_as_version_folder.yml

@@ -1,4 +1,4 @@
-name: deploy_build_latest_as_version_folder
+name: deploy_latest_as_version_folder
 
 on:
     push:
@@ -14,25 +14,33 @@ jobs:
         steps:
             -   name: Check out repository
                 uses: actions/checkout@v4
-
             -   name: Read version from package.json
                 id: set_version
-                run: |
-                    echo "version=$(jq -r .version package.json)" >> $GITHUB_OUTPUT
+                run: echo "version=$(jq -r .version package.json)" >> $GITHUB_OUTPUT
                 shell: bash
 
-            -   name: Print version
-                run: |
-                    echo "Version: ${{ steps.set_version.outputs.version }}"
+    deploy_samples:
+        if: github.repository == 'Dash-Industry-Forum/dash.js'
+        needs: get_version_number
+        uses: ./.github/workflows/deploy.yml
+        with:
+            envname: v${{ needs.get_version_number.outputs.version }}
+            deploy_path: '/377335/dash.js'
+            deploy_type: samples
+        secrets:
+            host: ${{ secrets.HOST }}
+            user: ${{ secrets.USER }}
+            private_key: ${{ secrets.PRIVATE_KEY }}
 
-    deploy:
+    deploy_build:
         if: github.repository == 'Dash-Industry-Forum/dash.js'
         needs: get_version_number
-        uses: ./.github/workflows/deploy_build.yml
+        uses: ./.github/workflows/deploy.yml
         with:
             envname: v${{ needs.get_version_number.outputs.version }}
             deploy_path: '/377335'
+            deploy_type: build
         secrets:
             host: ${{ secrets.HOST }}
             user: ${{ secrets.USER }}
-            private_key: ${{ secrets.PRIVATE_KEY }}
+            private_key: ${{ secrets.PRIVATE_KEY }}

.github/workflows/deploy_latest.yml

@@ -12,6 +12,7 @@ jobs:
         with:
             envname: latest
             deploy_path: '/377335/dash.js'
+            deploy_type: samples
         secrets:
             host: ${{secrets.HOST}}
             user: ${{secrets.USER}}

.github/workflows/deploy_nightly.yml

@@ -12,6 +12,7 @@ jobs:
         with:
             envname: nightly
             deploy_path: '/377335/dash.js'
+            deploy_type: samples
         secrets:
             host: ${{secrets.HOST}}
             user: ${{secrets.USER}}

.github/workflows/deploy_v4_latest.yml

@@ -12,6 +12,7 @@ jobs:
         with:
             envname: v4_latest
             deploy_path: '/377335/dash.js'
+            deploy_type: samples
         secrets:
             host: ${{secrets.HOST}}
             user: ${{secrets.USER}}

.github/workflows/deploy_v4_nightly.yml

@@ -12,6 +12,7 @@ jobs:
         with:
             envname: v4_nightly
             deploy_path: '/377335/dash.js'
+            deploy_type: samples
         secrets:
             host: ${{secrets.HOST}}
             user: ${{secrets.USER}}

.github/workflows/verify_branch.yml

@@ -3,29 +3,20 @@ name: verify_branch
 on:
     push:
         branches:
-            - '**'  # Triggers on push to any branch
+            - '**'
+            - '!master'
+            - '!development'
+            - '!v4_main'
+            - '!v4_development'
 
 jobs:
     build_and_unit_test:
-        runs-on: ubuntu-latest
+        runs-on: ubuntu-24.04
         steps:
+            # On push events, actions/checkout checks out the branch directly (no merge with a target branch).
+            # This only verifies the branch in isolation, unlike pull_request events which test a merge commit.
             -   uses: actions/checkout@v4
-            -   uses: actions/setup-node@v4
-                with:
-                    node-version: '20'
-                    cache: 'npm'
-            -   name: Cache node modules
-                id: cache-npm
-                uses: actions/cache@v3
-                with:
-                    path: node_modules
-                    key: ${{ runner.os }}-build-${{ hashFiles('**/package-lock.json') }}
-                    restore-keys: |
-                        ${{ runner.os }}-build-
-                        ${{ runner.os }}-
-            -   if: ${{ steps.cache-npm.outputs.cache-hit != 'true' }}
-                name: List the state of node modules
-                continue-on-error: true
-                run: npm list
-            -   run: npm install
-            -   run: npm run build
+            -   name: Setup dash.js
+                uses: ./.github/actions/setup-dashjs
+            -   name: Build and run unit tests
+                run: npm run build