Merge pull request #215 from hacki11/fix-gh-workflow

Quality improvements

.eslintignore

@@ -0,0 +1,2 @@
+**/.eslintrc.js
+admin/words.js

.eslintrc.json

@@ -1,10 +1,14 @@
 {
+    "root": true,
     "env": {
         "es6": true,
         "node": true,
         "mocha": true
     },
-    "extends": "eslint:recommended",
+    "extends": [
+        "eslint:recommended"
+    ],
+    "plugins": [],
     "rules": {
         "indent": [
             "error",
@@ -14,7 +18,15 @@
             }
         ],
         "no-console": "off",
+        "no-unused-vars": [
+            "error",
+            {
+                "ignoreRestSiblings": true,
+                "argsIgnorePattern": "^_"
+            }
+        ],
         "no-var": "error",
+        "no-trailing-spaces": "error",
         "prefer-const": "error",
         "quotes": [
             "error",
@@ -30,6 +42,6 @@
         ]
     },
     "parserOptions": {
-        "ecmaVersion": 2018
+        "ecmaVersion": 2020
     }
 }

.github/dependabot.yml

@@ -1,12 +1,22 @@
 version: 2
 updates:
-- package-ecosystem: npm
-  directory: "/"
-  schedule:
-    interval: monthly
-    time: "04:00"
-    timezone: Europe/Berlin
-  open-pull-requests-limit: 20
-  assignees:
-  - hacki11
-  versioning-strategy: increase
+  - package-ecosystem: npm
+    directory: "/"
+    schedule:
+      interval: monthly
+      time: "04:00"
+      timezone: Europe/Berlin
+    open-pull-requests-limit: 5
+    assignees:
+      - hacki11
+    versioning-strategy: increase
+
+  - package-ecosystem: github-actions
+    directory: "/"
+    schedule:
+      interval: monthly
+      time: "04:00"
+      timezone: Europe/Berlin
+    open-pull-requests-limit: 5
+    assignees:
+      - hacki11

.github/workflows/dependabot-auto-merge.yml

@@ -4,6 +4,8 @@
 name: Auto-Merge Dependabot PRs
 
 on:
+  # WARNING: This needs to be run in the PR base, DO NOT build untrusted code in this action
+  # details under https://github.blog/changelog/2021-02-19-github-actions-workflows-triggered-by-dependabot-prs-will-run-with-read-only-permissions/
   pull_request_target:
 
 jobs:
@@ -17,7 +19,9 @@ jobs:
       - name: Check if PR should be auto-merged
         uses: ahmadnassri/action-dependabot-auto-merge@v2
         with:
-          # This must be a personal access token with push access
+          # In order to use this, you need to go to https://github.com/settings/tokens and
+          # create a Personal Access Token with the permission "public_repo".
+          # Enter this token in your repository settings under "Secrets" and name it AUTO_MERGE_TOKEN
           github-token: ${{ secrets.AUTO_MERGE_TOKEN }}
           # By default, squash and merge, so Github chooses nice commit messages
           command: squash and merge

.github/workflows/test-and-release.yml

@@ -3,155 +3,90 @@ name: Test and Release
 # Run this job on all pushes and pull requests
 # as well as tags with a semantic version
 on:
-    push:
-        branches:
-            - "*"
-        tags:
-            # normal versions
-            - "v[0-9]+.[0-9]+.[0-9]+"
-            # pre-releases
-            - "v[0-9]+.[0-9]+.[0-9]+-**"
-    pull_request: {}
+  push:
+    branches:
+      - "*"
+    tags:
+      # normal versions
+      - "v[0-9]+.[0-9]+.[0-9]+"
+      # pre-releases
+      - "v[0-9]+.[0-9]+.[0-9]+-**"
+  pull_request: {}
+
+# Cancel previous PR/branch runs when a new commit is pushed
+concurrency:
+  group: ${{ github.ref }}
+  cancel-in-progress: true
 
 jobs:
-    # Performs quick checks before the expensive test runs
-    check-and-lint:
-        if: contains(github.event.head_commit.message, '[skip ci]') == false
-
-        runs-on: ubuntu-latest
-
-        strategy:
-            matrix:
-                node-version: [14.x]
-
-        steps:
-            - name: Checkout code
-              uses: actions/checkout@v3
-
-            - name: Use Node.js ${{ matrix.node-version }}
-              uses: actions/setup-node@v3.3.0
-              with:
-                  node-version: ${{ matrix.node-version }}
-
-            - name: Install Dependencies
-              run: npm ci
-
-            - name: Lint source code
-              run: npm run lint
-            - name: Test package files
-              run: npm run test:package
-
-    # Runs adapter tests on all supported node versions and OSes
-    adapter-tests:
-        if: contains(github.event.head_commit.message, '[skip ci]') == false
-
-        needs: [check-and-lint]
-
-        runs-on: ${{ matrix.os }}
-        strategy:
-            matrix:
-                node-version: [14.x, 16.x, 18.x]
-                os: [ubuntu-latest, windows-latest, macos-latest]
-
-        steps:
-            - name: Checkout code
-              uses: actions/checkout@v3
-
-            - name: Use Node.js ${{ matrix.node-version }}
-              uses: actions/setup-node@v3.3.0
-              with:
-                  node-version: ${{ matrix.node-version }}
-
-            - name: Install Dependencies
-              run: npm ci
-
-            - name: Run local tests
-              run: npm test
-            #- name: Run unit tests
-            #  run: npm run test:unit
-
-            #- name: Run integration tests (unix only)
-            #  if: startsWith(runner.OS, 'windows') == false
-            #  run: DEBUG=testing:* npm run test:integration
-
-            #- name: Run integration tests (windows only)
-            #  if: startsWith(runner.OS, 'windows')
-            #  run: set DEBUG=testing:* & npm run test:integration
-
-# TODO: To enable automatic npm releases, create a token on npmjs.org
+  # Performs quick checks before the expensive test runs
+  check-and-lint:
+    if: contains(github.event.head_commit.message, '[skip ci]') == false
+
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: ioBroker/testing-action-check@v1
+        with:
+          node-version: '18.x'
+          # Uncomment the following line if your adapter cannot be installed using 'npm ci'
+          # install-command: 'npm install'
+          lint: true
+
+  # Runs adapter tests on all supported node versions and OSes
+  adapter-tests:
+    if: contains(github.event.head_commit.message, '[skip ci]') == false
+
+    runs-on: ${{ matrix.os }}
+    strategy:
+      matrix:
+        node-version: [16.x, 18.x, 20.x]
+        os: [ubuntu-latest, windows-latest, macos-latest]
+
+    steps:
+      - uses: ioBroker/testing-action-adapter@v1
+        with:
+          node-version: ${{ matrix.node-version }}
+          os: ${{ matrix.os }}
+          # Uncomment the following line if your adapter cannot be installed using 'npm ci'
+          # install-command: 'npm install'
+
+# TODO: To enable automatic npm releases, create a token on npmjs.org 
 # Enter this token as a GitHub secret (with name NPM_TOKEN) in the repository options
 # Then uncomment the following block:
 
-    # Deploys the final package to NPM
-    deploy:
-        needs: [adapter-tests]
-
-        # Trigger this step only when a commit on any branch is tagged with a version number
-        if: |
-            contains(github.event.head_commit.message, '[skip ci]') == false &&
-            github.event_name == 'push' &&
-            startsWith(github.ref, 'refs/tags/v')
-
-        runs-on: ubuntu-latest
-        strategy:
-            matrix:
-                node-version: [14.x]
-
-        steps:
-            - name: Checkout code
-              uses: actions/checkout@v3
-
-            - name: Use Node.js ${{ matrix.node-version }}
-              uses: actions/setup-node@v3.3.0
-              with:
-                  node-version: ${{ matrix.node-version }}
-
-            - name: Extract the version and commit body from the tag
-              id: extract_release
-              # The body may be multiline, therefore newlines and % need to be escaped
-              run: |
-                  VERSION="${{ github.ref }}"
-                  VERSION=${VERSION##*/v}
-                  echo "::set-output name=VERSION::$VERSION"
-                  BODY=$(git show -s --format=%b)
-                  BODY="${BODY//'%'/'%25'}"
-                  BODY="${BODY//$'\n'/'%0A'}"
-                  BODY="${BODY//$'\r'/'%0D'}"
-                  echo "::set-output name=BODY::$BODY"
-
-            - name: Publish package to npm
-              run: |
-                  npm config set //registry.npmjs.org/:_authToken=${{ secrets.NPM_TOKEN }}
-                  npm whoami
-                  npm publish
-
-            - name: Create Github Release
-              uses: actions/create-release@v1
-              env:
-                  GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-              with:
-                  tag_name: ${{ github.ref }}
-                  release_name: Release v${{ steps.extract_release.outputs.VERSION }}
-                  draft: false
-                  # Prerelease versions create prereleases on Github
-                  prerelease: ${{ contains(steps.extract_release.outputs.VERSION, '-') }}
-                  body: ${{ steps.extract_release.outputs.BODY }}
-
-            # When using Sentry for error reporting, Sentry could be informed about new releases
-            # To enable create a API-Token in Sentry (User settings, API keys)
-            # Enter this token as a GitHub secret (with name SENTRY_AUTH_TOKEN) in the repository options
-            # Then uncomment and customize the following block:
-            #- name: Notify Sentry.io about the release
-            #  run: |
-            #      npm i -g @sentry/cli
-            #      export SENTRY_AUTH_TOKEN=${{ secrets.SENTRY_AUTH_TOKEN }}
-            #      export SENTRY_URL=https://sentry.iobroker.net
-            #      export SENTRY_ORG=iobroker
-            #      export SENTRY_PROJECT=iobroker-bsblan
-            #      export SENTRY_VERSION=iobroker.bsblan@${{ steps.extract_release.outputs.VERSION }}
-            #      sentry-cli releases new $SENTRY_VERSION
-            #      sentry-cli releases finalize $SENTRY_VERSION
-            #      # Add the following line BEFORE finalize if repositories are connected in Sentry
-            #      #sentry-cli releases set-commits $SENTRY_VERSION --auto
-            #      # Add the following line BEFORE finalize if sourcemap uploads are needed
-            #      #sentry-cli releases files $SENTRY_VERSION upload-sourcemaps build/
+  # Deploys the final package to NPM
+  deploy:
+    needs: [check-and-lint, adapter-tests]
+
+    # Trigger this step only when a commit on any branch is tagged with a version number
+    if: |
+      contains(github.event.head_commit.message, '[skip ci]') == false &&
+      github.event_name == 'push' &&
+      startsWith(github.ref, 'refs/tags/v')
+
+    runs-on: ubuntu-latest
+
+    # Write permissions are required to create Github releases
+    permissions:
+      contents: write
+
+    steps:
+      - uses: ioBroker/testing-action-deploy@v1
+        with:
+          node-version: '18.x'
+          # Uncomment the following line if your adapter cannot be installed using 'npm ci'
+          # install-command: 'npm install'
+          npm-token: ${{ secrets.NPM_TOKEN }}
+          github-token: ${{ secrets.GITHUB_TOKEN }}
+
+#          # When using Sentry for error reporting, Sentry can be informed about new releases
+#          # To enable create a API-Token in Sentry (User settings, API keys)
+#          # Enter this token as a GitHub secret (with name SENTRY_AUTH_TOKEN) in the repository options
+#          # Then uncomment and customize the following block:
+#          sentry: true
+#          sentry-token: ${{ secrets.SENTRY_AUTH_TOKEN }}
+#          sentry-project: "iobroker-bsblan"
+#          sentry-version-prefix: "iobroker.bsblan"
+#          # If your sentry project is linked to a GitHub repository, you can enable the following option
+#          # sentry-github-integration: true

.vscode/launch.json

@@ -12,7 +12,9 @@
             "skipFiles": ["<node_internals>/**"],
             "args": ["--debug", "0"],
             "program": "node_modules/iobroker.bsblan/main.js",
-            "cwd": "${workspaceFolder}/.dev-server/default"
+            "cwd": "${workspaceFolder}/.dev-server/default",
+            "localRoot": "${workspaceFolder}",
+            "remoteRoot": "${workspaceFolder}/.dev-server/default/node_modules/iobroker.bsblan",
           }
     ]
 }

README.md

@@ -41,6 +41,8 @@ The BSB_LAN Interface brings the BSB (Boiler System Bus) to LAN. This adapter co
 
 ## Changelog
 
+### 0.3.1
+* Code Quality Improvements
 ### 0.3.0
 * Add support for BSB_LAN 2.x
 * BREAKING: Names of 24h Average values changed (e.g. Außentemperatur_(8700) => 24h Durchschnittswert. Außentemperatur_(20050))

admin/words.js

@@ -1,4 +1,6 @@
-/*global systemDictionary:true */
+/* eslint no-unused-vars: off */
+/* eslint no-global-assign: off */
+/* global systemDictionary */
 "use strict";
 
 systemDictionary = {
@@ -12,6 +14,7 @@ systemDictionary = {
         "it": "Impostazioni dell'adattatore per bsblan",
         "es": "Ajustes del adaptador para bsblan",
         "pl": "Ustawienia adaptera dla bsblan",
+        "uk": "Налаштування адаптера для bsblan",
         "zh-cn": "bsblan的适配器设置"
     },
     "option1": {
@@ -24,18 +27,20 @@ systemDictionary = {
         "it": "opzione 1",
         "es": "Opción 1",
         "pl": "opcja 1",
+        "uk": "варіант1",
         "zh-cn": "选项1"
     },
     "option2": {
         "en": "option2",
         "de": "Option 2",
-        "ru": "option2",
+        "ru": "вариант 2",
         "pt": "opção 2",
         "nl": "Optie 2",
         "fr": "Option 2",
         "it": "opzione 2",
         "es": "opcion 2",
         "pl": "Opcja 2",
+        "uk": "варіант2",
         "zh-cn": "选项2"
     }
 };