Merge branch 'release51' into chore/openapi-ci

Author: Mint de Wit

.github/CODEOWNERS

@@ -0,0 +1 @@
+*  @nrkno/sofieteam

.github/ISSUE_TEMPLATE/rfc.yml

@@ -1,5 +1,5 @@
 name: Request for Comments ❗
-description: Use this to initiate a discussion about a new feature or a larger change
+description: Use this to initiate a discussion about a new feature or a larger change.
 title: "RFC: [Short description of the feature/change]"
 labels:
   - RFC
@@ -14,15 +14,15 @@ body:
 
   - type: textarea
     attributes:
-      label: About me
+      label: About Me
       description: Tell us who / which organization you are representing, and how the Sofie team will be able to contact you.
       placeholder: Example "This RFC is posted on behalf of the NRK."
     validations:
       required: true
 
   - type: textarea
     attributes:
-      label: Use case
+      label: Use Case
       description: "Please write some background information here, such as: What is your use case? What problem are you trying to solve?"
     validations:
       required: true

.github/PULL-REQUEST-TEMPLATE.md

@@ -30,13 +30,27 @@ What is the new behavior?
 -->
 
 
-## Testing Instructions
+## Testing
 <!--
-Please provide some instructions and other information for how to verify that the feature works.
+When you add a feature, you should also provide relevant unit tests, in order to 
+* ensure that the feature works as expected
+* ensure that the feature will continue to work in the future
+-->
+
+- [ ] I have added one or more unit tests for this PR
+- [ ] I have updated the relevant unit tests
+- [ ] No unit test changes are needed for this PR
+
+### Affected areas
+
+<!--
+Please provide some details on what areas of the system that are affected by this PR.
+This is useful for testers to know where to focus their testing efforts.
 Examples:
-* "Do a Take for a part that contains an adlib, verify that the adlib plays out."
-* "Open the Switchboard panel and toggle a route, verify that the route toggles in the GUI."
-* "This feature also affects 'feature X', so that needs to be tested for regressions as well."
+* This PR affects the playout logic in general.
+* This PR affects the timing calculation in the Rundown during playout.
+* This PR affects the NRC/MOS integration
+* 
 -->
 
 

.github/actions/setup-meteor/action.yaml

@@ -3,7 +3,7 @@ description: "Setup Meteor"
 runs:
   using: "composite"
   steps:
-    - run: curl "https://install.meteor.com/?release=2.7.3" | sh
+    - run: curl "https://install.meteor.com/?release=2.13.3" | sh
       shell: bash
     - run: meteor npm install -g yarn
       shell: bash

.github/workflows/node.yaml

@@ -42,6 +42,10 @@ jobs:
       - name: Run typecheck and linter
         run: |
           cd meteor
+
+          # setup zodern:types. No linters are setup, so this simply installs the packages
+          meteor lint
+
           meteor yarn ci:lint
         env:
           CI: true
@@ -77,6 +81,10 @@ jobs:
       - name: Run Tests
         run: |
           cd meteor
+
+          # setup zodern:types. No linters are setup, so this simply installs the packages
+          meteor lint
+
           NODE_OPTIONS="--max-old-space-size=6144" meteor yarn unitci --force-exit
         env:
           CI: true
@@ -204,7 +212,7 @@ jobs:
           password: ${{ secrets.GITHUB_TOKEN }}
       - name: Build and push to GHCR
         if: steps.check-build-and-push.outputs.enable == 'true' && steps.check-ghcr.outputs.enable == 'true' && steps.ghcr-tag.outputs.tags != 0
-        uses: docker/build-push-action@v5
+        uses: docker/build-push-action@v6
         with:
           context: .
           file: ./meteor/Dockerfile.circle
@@ -215,7 +223,7 @@ jobs:
           github-token: ${{ github.token }}
       - name: Build and push to DockerHub
         if: steps.check-build-and-push.outputs.enable == 'true' && steps.dockerhub.outputs.dockerhub-publish == '1'
-        uses: docker/build-push-action@v5
+        uses: docker/build-push-action@v6
         with:
           context: .
           file: ./meteor/Dockerfile.circle
@@ -231,7 +239,7 @@ jobs:
           echo "image=$image" >> $GITHUB_OUTPUT
       - name: Trivy scanning
         if: steps.check-build-and-push.outputs.enable == 'true' && steps.check-ghcr.outputs.enable == 'true' && steps.ghcr-tag.outputs.tags != 0
-        uses: aquasecurity/trivy-action@0.17.0
+        uses: aquasecurity/trivy-action@0.24.0
         with:
           image-ref: "${{ steps.trivy-image.outputs.image }}"
           format: "table"
@@ -354,7 +362,7 @@ jobs:
           password: ${{ secrets.GITHUB_TOKEN }}
       - name: Build and push to GHCR
         if: steps.check-build-and-push.outputs.enable == 'true' && steps.check-ghcr.outputs.enable == 'true' && steps.ghcr-tag.outputs.tags != 0
-        uses: docker/build-push-action@v5
+        uses: docker/build-push-action@v6
         with:
           context: ./packages
           file: ./packages/${{ matrix.gateway-name }}/Dockerfile.circle
@@ -364,7 +372,7 @@ jobs:
           tags: "${{ steps.ghcr-tag.outputs.tags }}"
       - name: Build and push to DockerHub
         if: steps.check-build-and-push.outputs.enable == 'true' && steps.dockerhub.outputs.dockerhub-publish == '1'
-        uses: docker/build-push-action@v5
+        uses: docker/build-push-action@v6
         with:
           context: ./packages
           file: ./packages/${{ matrix.gateway-name }}/Dockerfile.circle
@@ -380,7 +388,7 @@ jobs:
           echo "image=$image" >> $GITHUB_OUTPUT
       - name: Trivy scanning
         if: steps.check-build-and-push.outputs.enable == 'true' && steps.check-ghcr.outputs.enable == 'true' && steps.ghcr-tag.outputs.tags != 0
-        uses: aquasecurity/trivy-action@0.17.0
+        uses: aquasecurity/trivy-action@0.24.0
         with:
           image-ref: "${{ steps.trivy-image.outputs.image }}"
           format: "table"
@@ -459,7 +467,7 @@ jobs:
           - blueprints-integration
           - server-core-integration
           - shared-lib
-        node-version: [14.x, 16.x, 18.x]
+        node-version: [14.x, 16.x, 18.x, 20.x]
         include:
           # include additional configs, to run certain packages only for a certain version of node
           - node-version: 14.x
@@ -473,6 +481,8 @@ jobs:
             package-name: openapi
           - node-version: 18.x
             package-name: openapi
+          - node-version: 20.x
+            package-name: openapi
           # No tests for the gateways yet
           # - node-version: 18.x
           #   package-name: playout-gateway
@@ -515,6 +525,60 @@ jobs:
         env:
           CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }}
 
+  asyncapi-generation:
+    name: AsyncAPI Generation
+    runs-on: ubuntu-latest
+    timeout-minutes: 15
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          persist-credentials: false
+      - name: Use Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version-file: ".node-version"
+      - name: Prepare Environment
+        run: |
+          cd packages
+          yarn
+        env:
+          CI: true
+      - name: Run generator
+        run: |
+          cd packages/live-status-gateway
+
+          yarn gendocs
+          yarn genserver
+        env:
+          CI: true
+  openapi-generation:
+    name: OpenAPI Generation
+    runs-on: ubuntu-latest
+    timeout-minutes: 15
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          persist-credentials: false
+      - name: Use Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version-file: ".node-version"
+      - name: Prepare Environment
+        run: |
+          cd packages
+          yarn
+        env:
+          CI: true
+      - name: Run generator
+        run: |
+          cd packages/openapi
+
+          yarn gendocs
+          yarn genserver
+          yarn genclient:ts
+        env:
+          CI: true
+
   publish-docs:
     name: Publish Docs
     runs-on: ubuntu-latest
@@ -558,7 +622,7 @@ jobs:
           CI: true
       - name: Publish
         if: github.ref == 'refs/heads/master' # always publish for just the master branch
-        uses: peaceiris/actions-gh-pages@v3
+        uses: peaceiris/actions-gh-pages@v4
         with:
           github_token: ${{ secrets.GITHUB_TOKEN }}
           publish_dir: ./packages/documentation/build

.github/workflows/prerelease-libs.yml

@@ -53,7 +53,7 @@ jobs:
           - blueprints-integration
           - server-core-integration
           - shared-lib
-        node-version: [14.x, 16.x, 18.x]
+        node-version: [14.x, 16.x, 18.x, 20.x]
 
     steps:
       - uses: actions/checkout@v4

.github/workflows/sonar.yaml

@@ -12,7 +12,8 @@ jobs:
   sonarcloud:
     name: SonarCloud
     runs-on: ubuntu-latest
-    if: ${{ github.repository_owner == 'nrkno' }}
+    if: ${{ github.repository_owner == 'nrkno' && !github.event.pull_request.head.repo.fork }}
+    timeout-minutes: 15
 
     steps:
       - uses: actions/checkout@v4

.github/workflows/trivy.yml

@@ -11,16 +11,18 @@ jobs:
     strategy:
       matrix:
         image: ["server-core", "playout-gateway", "mos-gateway"]
+    timeout-minutes: 15
+
     steps:
       - name: Run Trivy vulnerability scanner (json)
-        uses: aquasecurity/trivy-action@0.17.0
+        uses: aquasecurity/trivy-action@0.24.0
         with:
           image-ref: ghcr.io/nrkno/sofie-core-${{ matrix.image }}:latest
           format: json
           output: '${{ matrix.image }}-trivy-scan-results.json'
 
       - name: Run Trivy vulnerability scanner (table)
-        uses: aquasecurity/trivy-action@0.17.0
+        uses: aquasecurity/trivy-action@0.24.0
         with:
           image-ref: ghcr.io/nrkno/sofie-core-${{ matrix.image }}:latest
           output: '${{ matrix.image }}-trivy-scan-results.txt'
@@ -36,7 +38,7 @@ jobs:
           echo $CODE_BLOCK >> $GITHUB_STEP_SUMMARY
 
       - name: Run Trivy in GitHub SBOM mode and submit results to Dependency Graph
-        uses: aquasecurity/trivy-action@0.17.0
+        uses: aquasecurity/trivy-action@0.24.0
         with:
           format: 'github'
           output: 'dependency-results-${{ matrix.image }}.sbom.json'
@@ -54,7 +56,7 @@ jobs:
           echo ${{ env.SUMMARY }}
 
       - name: Send Slack Notification
-        uses: slackapi/slack-github-action@v1.25.0
+        uses: slackapi/slack-github-action@v1.26.0
         with:
           payload: |
             {

DEVELOPER.md

@@ -18,11 +18,14 @@ Follow these instructions to start up Sofie Core in development mode. (For produ
 
 ### Prerequisites
 
-- Install [Node.js](https://nodejs.org) 18 (14 should also work) (using [nvm](https://github.com/nvm-sh/nvm) or [nvm-windows](https://github.com/coreybutler/nvm-windows) is the recommended way to install Node.js)
-- If on Windows: `npm install --global windows-build-tools`
-- Install [Meteor](https://www.meteor.com/install) (`npm install --global meteor`)
+- Install [Node.js](https://nodejs.org) 14 (using [nvm](https://github.com/nvm-sh/nvm) or [nvm-windows](https://github.com/coreybutler/nvm-windows) is the recommended way to install Node.js)
+- Install [Meteor](https://www.meteor.com/install) (`npm install --global meteor@2`)
+- Install [Node.js](https://nodejs.org) 18 (using the same method you used above, you can uninstall node 14 if needed)
+- Install an older version of corepack (`npm install --global [email protected]`)
 - Enable [corepack](https://nodejs.org/api/corepack.html#corepack) (`corepack enable`) as administrator/root. If `corepack` is not found, you may need to install it first with `npm install --global corepack`
 
+- If on Windows, you may need to `npm install --global windows-build-tools` but this is not always necessary
+
 ### Quick Start
 
 ```bash
@@ -129,6 +132,30 @@ The resulting JSON file will be placed in `meteor/public/locales/xx`, where it w
 
 Then submit this as a PR.
 
+## Deprecations
+
+### ConfigManifests
+
+The ConfigManifests for Blueprints and Gateways was replaced with JSONSchema in R50.  
+However, one usage by AdlibActions for their userDataManifest remains as this is not something we are actively using.
+
+## Blueprint Migrations
+
+In R49, a replacement flow was added consisting of `validateConfig` and `applyConfig`.  
+It is no longer recommended to use the old migrations flow for showstyle and studio blueprints.
+
+### ExpectedMediaItems
+
+These are used for Media-manager which is no longer being developed.
+
+### Blueprints: getPieceABSessionId & getTimelineObjectAbSessionId
+
+With AB being a native concept supported by Sofie since R50, these are likely no longer useful to Blueprints.
+
+### MongoQuery `fields` specifier
+
+It is recommended to use `projection` instead, as it is functionally identical but follows recommended naming from mongodb.
+
 ## Other info
 
 ### Version-Numbering Scheme

README.md

@@ -4,14 +4,14 @@ This is the _Core_ application of the [**Sofie** TV Automation System](https://g
 
 The _Core_ is a _Meteor/Node.JS_-based web server that serves the web GUIs as well as handling the business logic for the Sofie system.
 
-* [_Core_-specific Developer Info](DEVELOPER.md)
-
+- [_Core_-specific Developer Info](DEVELOPER.md)
 
 ## General Sofie System Information
-* [_Sofie_ Documentation](https://nrkno.github.io/sofie-core/)
-* [_Sofie_ Releases](https://nrkno.github.io/sofie-core/releases)
-* [Contribution Guidelines](CONTRIBUTING.md)
-* [License](LICENSE)
+
+- [_Sofie_ Documentation](https://nrkno.github.io/sofie-core/)
+- [_Sofie_ Releases](https://nrkno.github.io/sofie-core/releases)
+- [Contribution Guidelines](CONTRIBUTING.md)
+- [License](LICENSE)
 
 ---