Skip to content

Commit 51c4ca1

Browse files
committed
Merge branch 'release50' into release51
2 parents c10d27d + edf9fed commit 51c4ca1

File tree

4 files changed

+36
-27
lines changed

4 files changed

+36
-27
lines changed

.github/dependabot.yml

Lines changed: 12 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,17 @@
11
version: 2
22
updates:
3-
# # Enable version updates for npm
4-
# - package-ecosystem: "npm"
5-
# # Look for `package.json` and `lock` files in the `root` directory
6-
# directory: "/"
7-
# # Check the npm registry for updates every day (weekdays)
8-
# schedule:
9-
# interval: "daily"
3+
# Enable version updates for npm
4+
- package-ecosystem: "npm"
5+
# Look for `package.json` and `lock` files in the `root` directory
6+
directory: "/"
7+
# Check the npm registry for updates every day (weekdays)
8+
schedule:
9+
interval: "daily"
10+
# Only create security updates
11+
open-pull-requests-limit: 0
12+
# Default reviewers
13+
reviewers:
14+
- "@nrkno/sofieteam"
1015

1116
- package-ecosystem: "github-actions"
1217
# Workflow files stored in the
@@ -16,17 +21,3 @@ updates:
1621
interval: "weekly"
1722
reviewers:
1823
- "@nrkno/sofie-ops"
19-
20-
# # Enable version updates for Docker
21-
# - package-ecosystem: "docker"
22-
# directory: "/meteor"
23-
# schedule:
24-
# interval: "weekly"
25-
# - package-ecosystem: "docker"
26-
# directory: "/packages/mos-gateway"
27-
# schedule:
28-
# interval: "weekly"
29-
# - package-ecosystem: "docker"
30-
# directory: "/packages/playout-gateway"
31-
# schedule:
32-
# interval: "weekly"

.github/workflows/node.yaml

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -163,7 +163,7 @@ jobs:
163163
- uses: ./.github/actions/setup-meteor
164164
if: steps.check-build-and-push.outputs.enable == 'true'
165165
- name: restore node_modules
166-
uses: actions/cache@v3
166+
uses: actions/cache@v4
167167
if: steps.check-build-and-push.outputs.enable == 'true'
168168
with:
169169
path: |
@@ -331,7 +331,7 @@ jobs:
331331
node-version-file: ".node-version"
332332
- name: restore node_modules
333333
if: steps.check-build-and-push.outputs.enable == 'true'
334-
uses: actions/cache@v3
334+
uses: actions/cache@v4
335335
with:
336336
path: |
337337
packages/node_modules
@@ -435,7 +435,7 @@ jobs:
435435
with:
436436
node-version-file: ".node-version"
437437
- name: restore node_modules
438-
uses: actions/cache@v3
438+
uses: actions/cache@v4
439439
with:
440440
path: |
441441
packages/node_modules
@@ -498,7 +498,7 @@ jobs:
498498
with:
499499
node-version: ${{ matrix.node-version }}
500500
- name: restore node_modules
501-
uses: actions/cache@v3
501+
uses: actions/cache@v4
502502
with:
503503
path: |
504504
packages/node_modules
@@ -594,7 +594,7 @@ jobs:
594594
with:
595595
node-version-file: ".node-version"
596596
- name: restore node_modules
597-
uses: actions/cache@v3
597+
uses: actions/cache@v4
598598
with:
599599
path: |
600600
packages/node_modules

.github/workflows/sonar.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ jobs:
2727
node-version-file: ".node-version"
2828
- uses: ./.github/actions/setup-meteor
2929
- name: restore node_modules
30-
uses: actions/cache@v3
30+
uses: actions/cache@v4
3131
with:
3232
path: |
3333
node_modules

packages/documentation/docs/for-developers/contribution-guidelines.md

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -76,3 +76,21 @@ Also, each of the libraries has a minimum nodejs version specified in their pack
7676
We sometimes use the `yarn resolutions` property in `package.json` to fix security vulnerabilities in dependencies of libraries that haven't released a fix yet. If adding a new one, try to make it as specific as possible to ensure it doesn't have unintended side effects.
7777

7878
When updating other dependencies, it is a good idea to make sure that the resolutions defined still apply and are correct.
79+
80+
### Logging
81+
82+
When logging, we try to adher to the following guideliness:
83+
84+
Usage of `console.log` and `console.error` directly is discouraged (except for quick debugging locally). Instead, use one of the logger libraries (to output json logs which are easier to index).
85+
When logging, use one of the **log level** described below:
86+
87+
| Level | Description | Examples |
88+
| ------- | ----------- | -- |
89+
| `silly` | For very detailed logs (rarely used). | - |
90+
| `debug` | Logging of info that could be useful for developers when debugging certain issues in production. | `"payload: {>JSON<} "`<br></br>`"Reloading data X from DB"` |
91+
| `verbose` | Logging of common events. | `"File X updated"` |
92+
| `info` | Logging of significant / uncommon events.<br></br>_Note: If an event happens often or many times, use `verbose` instead._ | `"Initializing TSR..."`<br></br>`"Starting nightly cronjob..."`<br></br>`"Snapshot X restored"`<br></br>`"Not allowing removal of current playing segment 'xyz', making segment unsynced instead"`<br></br>`"PeripheralDevice X connected"` |
93+
| `warn` | Used when something unexpected happened, but not necessarily due to an application bug.<br></br>These logs don't have to be acted upon directly, but could be useful to provide context to a dev/sysadmin while troubleshooting an issue. | `"PeripheralDevice X disconnected"`<br></br>`"User Error: Cannot activate Rundown (Rundown not found)" `<br></br>`"mosRoItemDelete NOT SUPPORTED"` |
94+
| `error` | Used when something went _wrong_, preventing something from functioning.<br></br>A logged `error` should always result in a sysadmin / developer looking into the issue.<br></br>_Note: Don't use `error` for things that are out of the app's control, such as user error._ | `"Cannot read property 'length' of undefined"`<br></br>`"Failed to save Part 'X' to DB"`|
95+
| `crit` | Fatal errors (rarely used) | - |
96+

0 commit comments

Comments
 (0)