Merge branch 'main' into dependabot/github_actions/actions/setup-node-3

.github/workflows/build-project.yml

@@ -20,7 +20,7 @@ jobs:
 
     steps:
       - name: Checkout
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4.1.0
 
       - name: Cache Docker Register
         if: ${{ github.event_name == 'pull_request' }}
@@ -53,7 +53,7 @@ jobs:
           npm run-script build
       - name: Build docker image
         if: ${{ github.event_name == 'pull_request' }}
-        uses: docker/build-push-action@v4
+        uses: docker/build-push-action@v5
         with:
           # Set the context to use the current directory and not execute it's own git checkout.
           context: .

.github/workflows/release-project.yml

@@ -16,7 +16,7 @@ jobs:
 
     steps:
       - name: Checkout
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4.1.0
 
       - name: Cache Docker Register
         uses: actions/cache@v3
@@ -47,7 +47,7 @@ jobs:
           npm ci
           npm run-script build
       - name: Build and push docker image to Docker Hub
-        uses: docker/build-push-action@v4
+        uses: docker/build-push-action@v5
         with:
           # Set the context to use the current directory and not execute it's own git checkout.
           context: .

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

@@ -6,7 +6,7 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout
-        uses: actions/checkout@v2.3.1
+        uses: actions/checkout@v4.1.0
 
       - name: Use Node.js 18.x
         uses: actions/setup-node@v3

.github/workflows/test.yml

@@ -9,7 +9,7 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout
-        uses: actions/checkout@v2.3.1
+        uses: actions/checkout@v4.1.0
 
       - name: Use Node.js 18.x
         uses: actions/setup-node@v3

CHANGELOG.md

@@ -2,6 +2,20 @@
 
 All notable changes to this project will be documented in this file. See [standard-version](https://github.com/conventional-changelog/standard-version) for commit guidelines.
 
+## [0.33.0](https://github.com/openscd/open-scd/compare/v0.32.0...v0.33.0) (2023-06-22)
+
+
+### Features
+
+* **openscd:** Move progress indicator beneath plugin tabs ([#1181](https://github.com/openscd/open-scd/issues/1181)) ([a7a7081](https://github.com/openscd/open-scd/commits/a7a7081a32ee14998d0ead75ffb89ba2726631f8)), closes [#1178](https://github.com/openscd/open-scd/issues/1178)
+
+
+### Bug Fixes
+
+* **editing:** use editCount property for change propagation ([#1233](https://github.com/openscd/open-scd/issues/1233)) ([548f63b](https://github.com/openscd/open-scd/commits/548f63b5b35dac6772230004e6ca7859cf3337b8))
+* escaped symbols in regex patterns ([#1266](https://github.com/openscd/open-scd/issues/1266)) ([de2dd0d](https://github.com/openscd/open-scd/commits/de2dd0dc2351c8feb6a70da62e43640334df571b))
+* goose subscription reflects state incorrectly ([#1261](https://github.com/openscd/open-scd/issues/1261)) ([4440bff](https://github.com/openscd/open-scd/commits/4440bff63c0ebe816a9fdc25f8af6da1ca6645f4))
+
 ## [0.31.0](https://github.com/openscd/open-scd/compare/v0.30.0...v0.31.0) (2023-05-02)
 
 

Dockerfile

@@ -4,3 +4,4 @@ COPY build/. /app/
 VOLUME /opt/bitnami/nginx/conf/server_blocks/
 VOLUME /app/public/cim
 VOLUME /app/public/conf
+VOLUME /app/public/nsdoc

README.md

@@ -21,6 +21,10 @@ to use the CoMPAS Backend Service to open and save SCL Files and more.
 
 See [Development](DEVELOPMENT.md) for more information about how to build and run CoMPAS OpenSCD locally.
 
+## Releasing
+
+See [Releasing](RELEASING.md) for a step by step guide on releasing this fork with the latest version of [open-scd](https://github.com/openscd/open-scd/).
+
 ## License
 
 The [IEC 61850](https://webstore.iec.ch/publication/63319) XSD and NSD code components used are

RELEASING.md

@@ -0,0 +1,44 @@
+# Quick guide on how to release a new version of CoMPAS OpenSCD
+
+### Generally we follow these steps for releasing a new version:
+
+1. First make sure you have the correct upstream URL configured in your local **compas-open-scd** repo by running `git remote -v`.
+
+    You should see something like this:
+
+    ```bash
+    juan@Juans-MBP compas-open-scd % git remote -v             
+    origin  git@github.com:com-pas/compas-open-scd.git (fetch)
+    origin  git@github.com:com-pas/compas-open-scd.git (push)
+    upstream        git@github.com:openscd/open-scd.git (fetch)
+    upstream        git@github.com:openscd/open-scd.git (push)
+    ```
+
+    If you don’t see the second set of upstream URLs then you need to add **open-scd** as your upstream repo by running: 
+
+    `git remote add upstream https://github.com/openscd/open-scd.git`  
+
+2. Sync the changes from **open-scd**
+
+    `git fetch upstream`
+
+3. Create a new release branch from the latest release of open-scd (this could be *upstream/main* if it was just released or the specific *commit hash* of the release), using a branch name relative to the desired release tag like *release_v0_33_0_1*:
+
+    `git checkout 5aa52454f3e3bb88efef7c8fb466d4d3cc48d20d -b release_v0_33_0_1` (example with commit hash)
+
+    or
+
+    `git checkout upstream/main -b release_v0_33_0_1`  (example using open-scd's main branch)
+
+4. Merge changes from *origin/main* into your release branch like this:
+    
+    `git merge main --strategy recursive`
+    
+5. Make sure tests are passing, add fixes for breaking changes from **open-scd**
+6. Update the version number in your project's `package.json` file.
+7. Push the changes in your release branch to origin:
+    `git push --set-upstream origin release_v0_33_0_1`
+8. Create a PR from your release branch into *main* 
+9. Create a new release on GitHub and tag it with the new version number.
+10. Include automatic release notes summarizing the changes in this release.
+11. Publish the release and update all the CoMPAS projects with a dependency on this repo to the newly released version.

index.html

@@ -14,11 +14,11 @@
   <base href="/">
 
   <!-- Original URL from Google: https://fonts.googleapis.com/css2?family=Roboto+Mono:wght@300&family=Roboto:wght@300;400;500&display=swap -->
-  <link href="public/google/fonts/roboto-v27.css" rel="stylesheet">
-  <link href="public/google/fonts/roboto-mono-v13.css" rel="stylesheet">
+  <link href="/public/google/fonts/roboto-v27.css" rel="stylesheet">
+  <link href="/public/google/fonts/roboto-mono-v13.css" rel="stylesheet">
   <!-- Original URL from Google: https://fonts.googleapis.com/css?family=Material+Icons+Outlined&display=block -->
-  <link href="public/google/icons/material-icons-outlined.css" rel="stylesheet">
-  <link href="public/css/normalize.css" rel="stylesheet">
+  <link href="/public/google/icons/material-icons-outlined.css" rel="stylesheet">
+  <link href="/public/css/normalize.css" rel="stylesheet">
   <link rel="manifest" href="manifest.json" crossorigin="use-credentials">
   <link rel="icon" type="image/png" sizes="16x16" href="public/favicon-16x16.png">
   <link rel="icon" type="image/png" sizes="32x32" href="public/favicon-32x32.png">

manifest.json

@@ -40,5 +40,5 @@
       "purpose": "maskable"
     }
   ],
-  "version": "0.31.0"
+  "version": "0.33.0"
 }

package.json

@@ -1,6 +1,6 @@
 {
   "name": "open-scd",
-  "version": "0.31.0",
+  "version": "0.33.0",
   "repository": "https://github.com/openscd/open-scd.git",
   "description": "A bottom-up substation configuration designer for projects described using SCL `IEC 61850-6` Edition 2 or greater.",
   "keywords": [
@@ -17,7 +17,6 @@
   "module": "open-scd.js",
   "type": "module",
   "dependencies": {
-    "@material/mwc-circular-progress-four-color": "0.22.1",
     "@material/mwc-dialog": "0.22.1",
     "@material/mwc-drawer": "0.22.1",
     "@material/mwc-fab": "0.22.1",

public/js/plugins.js

@@ -1,15 +1,15 @@
 export const officialPlugins = [
   {
-    name: 'Substation',
-    src: '/src/editors/Substation.js',
-    icon: 'margin',
+    name: 'IED',
+    src: '/src/editors/IED.js',
+    icon: 'developer_board',
     default: true,
     kind: 'editor',
   },
   {
-    name: 'IED',
-    src: '/src/editors/IED.js',
-    icon: 'developer_board',
+    name: 'Substation',
+    src: '/src/editors/Substation.js',
+    icon: 'margin',
     default: true,
     kind: 'editor',
   },
@@ -24,14 +24,14 @@ export const officialPlugins = [
     name: 'Subscriber Message Binding (GOOSE)',
     src: '/src/editors/GooseSubscriberMessageBinding.js',
     icon: 'link',
-    default: true,
+    default: false,
     kind: 'editor',
   },
   {
     name: 'Subscriber Data Binding (GOOSE)',
     src: '/src/editors/GooseSubscriberDataBinding.js',
     icon: 'link',
-    default: true,
+    default: false,
     kind: 'editor',
   },
   {
@@ -45,14 +45,14 @@ export const officialPlugins = [
     name: 'Subscriber Message Binding (SMV)',
     src: '/src/editors/SMVSubscriberMessageBinding.js',
     icon: 'link',
-    default: true,
+    default: false,
     kind: 'editor',
   },
   {
     name: 'Subscriber Data Binding (SMV)',
     src: '/src/editors/SMVSubscriberDataBinding.js',
     icon: 'link',
-    default: true,
+    default: false,
     kind: 'editor',
   },
   {
@@ -168,10 +168,10 @@ export const officialPlugins = [
     position: 'top',
   },
   {
-    name: 'Validate using OCL',
+    name: '[WIP] Validate using OCL',
     src: '/src/validators/CompasValidateSchema.js',
     icon: 'rule_folder',
-    default: true,
+    default: false,
     kind: 'validator',
   },
   {
@@ -322,14 +322,14 @@ export const officialPlugins = [
   },
   {
     name: 'Sitipe',
-    src: '/src/editors/Sitipe.js',
-    icon: 'conveyor_belt',
+    src: '/src/compas-editors/Sitipe.js',
+    icon: 'precision_manufacturing',
     default: true,
     kind: 'editor',
   },
   {
     name: 'Autogen Substation',
-    src: '/src/editors/substation/autogen-substation/autogen-substation.js',
+    src: '/src/compas-editors/autogen-substation.js',
     icon: 'playlist_add_circle',
     default: true,
     kind: 'menu',

public/nsdoc/README.md

@@ -0,0 +1,6 @@
+Directory containing fixed nsdoc for the 'Validation' plugin:
+
+- IEC_61850-7-2_2007B3-en.nsdoc
+- IEC_61850-7-3_2007B3-en.nsdoc
+- IEC_61850-7-4_2007B3-en.nsdoc
+- IEC_61850-8-1_2003A2-en.nsdoc