Merge pull request #291 from com-pas/release_v0_33_0_6

Sync CoMPAS-OpenSCD with OpenSCD

Author: juancho0202

.github/dependabot.yml

@@ -12,7 +12,7 @@ updates:
       interval: "daily"
     open-pull-requests-limit: 5
   - package-ecosystem: "docker"
-    directory: "packages/compas-openscd/"
+    directory: "packages/compas-open-scd/"
     schedule:
       interval: "daily"
     open-pull-requests-limit: 5

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

@@ -17,4 +17,4 @@ jobs:
         run: |
           cd packages/compas-open-scd
           npm ci
-          npm run-script build
+          npm run-script build

.github/workflows/test.yml

@@ -1,5 +1,5 @@
 name: Test
-on: 
+on:
   push:
     branches-ignore:
       - main
@@ -20,4 +20,4 @@ jobs:
         run: |
           cd packages/compas-open-scd
           npm ci
-          npm run-script test
+          npm run-script test

README.md

@@ -21,14 +21,15 @@ to use the CoMPAS Backend Service to open and save SCL Files and more.
 
 This repository is a [↗ monorepo](https://en.wikipedia.org/wiki/Monorepo), made up of several packages.
 To find out more about the development of each packages, such as the base distribution or the plugins, please refer to their respective READMEs:
+
 - [open-scd](packages/open-scd/README.md): provides the (upstream) base distribution available on [openscd.github.io](https://openscd.github.io)
 - [compas-open-scd](packages/compas-open-scd/README.md): provides the base distribution available on [demo.compas.energy](https://demo.compas.energy)
 
 ## Contributing
 
 A recommended read for every newcomer to the CoMPAS project is [the CoMPAS Contributing guide](https://com-pas.github.io/contributing/).
 
-You can also get in touch by joining the `#compas` channel hosted on [the LF Energy Slack server](https://lfenergy.slack.com/archives/C01926K9D39). 
+You can also get in touch by joining the `#compas` channel hosted on [the LF Energy Slack server](https://lfenergy.slack.com/archives/C01926K9D39).
 
 ## Documentation
 

docs/decisions/0002-use-monorepo.md

@@ -0,0 +1,33 @@
+# 2. Use Monorepo
+
+Date: 2023-08
+
+## Status
+
+Accepted
+
+## Context
+
+We want:
+  - better access management to core functionalities, plugins and ui components
+  - easier maintainability and refactorability of critical parts
+  - more shareable code
+
+
+## Decision
+
+We will use a monorepo to manage the codebase for the time being. 
+
+To control access to the codebase we will use CODEOWNERS files.
+
+
+## Consequences
+
+- it makes the the dependency discovery and management easier between packages
+- we can add packages that can be deployed and published independently and still used directly inside the monorepo
+- it will allow us to experiment and beta test packages before publishing them
+- CI pipeline runs will be faster because changes are more separated
+- it will make it harder to bundle and distribute parts of the base distribution
+- it moves the complexity of package management into a concentrated place
+
+

docs/decisions/README.md

@@ -0,0 +1,4 @@
+# Decisions
+
+- [ADR-0001: Record architecture decisions](0001-record-architecture-decisions.md) <kbd>✅ active</kbd>
+- [ADR-0002: Use Monorepo](0002-use-monorepo.md) <kbd>✅ active</kbd>