Skip to content

Commit b901f9a

Browse files
author
Dennis Labordus
committed
Merge branch 'main' into upstream-v0.7
Signed-off-by: Dennis Labordus <[email protected]>
2 parents 953f2cc + d19e2af commit b901f9a

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

58 files changed

+3103
-167
lines changed

‎.github/workflows/automate-projects.yml‎

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
# SPDX-FileCopyrightText: 2021 Alliander N.V.
2+
#
3+
# SPDX-License-Identifier: CC-BY-4.0
4+
5+
name: Add issues and pull request to project boards
6+
7+
on: [ issues, pull_request ]
8+
9+
jobs:
10+
github-actions-automate-projects:
11+
runs-on: ubuntu-latest
12+
steps:
13+
- name: add-new-issues-to-repository-based-project-column
14+
uses: docker://takanabe/github-actions-automate-projects:v0.0.1
15+
if: github.event_name == 'issues' && github.event.action == 'opened'
16+
env:
17+
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
18+
GITHUB_PROJECT_URL: https://github.com/com-pas/compas-open-scd/projects/1
19+
GITHUB_PROJECT_COLUMN_NAME: To do
20+
- name: add-new-pull-request-to-repository-based-project-column
21+
uses: docker://takanabe/github-actions-automate-projects:v0.0.1
22+
if: github.event_name == 'pull_request' && github.event.action == 'opened'
23+
env:
24+
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
25+
GITHUB_PROJECT_URL: https://github.com/com-pas/compas-open-scd/projects/1
26+
GITHUB_PROJECT_COLUMN_NAME: To do
27+
- name: add-new-issues-to-organization-based-project-column
28+
uses: docker://takanabe/github-actions-automate-projects:v0.0.1
29+
if: github.event_name == 'issues' && github.event.action == 'opened'
30+
env:
31+
GITHUB_TOKEN: ${{ secrets.ORG_GITHUB_ACTION_SECRET }}
32+
GITHUB_PROJECT_URL: https://github.com/orgs/com-pas/projects/1
33+
GITHUB_PROJECT_COLUMN_NAME: To do
34+
- name: add-new-pull-request-to-organization-based-project-column
35+
uses: docker://takanabe/github-actions-automate-projects:v0.0.1
36+
if: github.event_name == 'pull_request' && github.event.action == 'opened'
37+
env:
38+
GITHUB_TOKEN: ${{ secrets.ORG_GITHUB_ACTION_SECRET }}
39+
GITHUB_PROJECT_URL: https://github.com/orgs/com-pas/projects/2
40+
GITHUB_PROJECT_COLUMN_NAME: To do

‎.github/workflows/build-project.yml‎

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
name: Build Project
2+
3+
on: push
4+
5+
jobs:
6+
build:
7+
name: Build
8+
runs-on: ubuntu-latest
9+
timeout-minutes: 15
10+
11+
steps:
12+
- uses: actions/checkout@v2
13+
- name: Use Node.js 14.x
14+
uses: actions/setup-node@v1
15+
with:
16+
node-version: '14.x'
17+
- name: Build application with npm
18+
run: |
19+
npm ci
20+
npm run-script build
21+
- name: Build docker image
22+
uses: docker/build-push-action@v2
23+
with:
24+
# Set the context to use the current directory and not execute it's own git checkout.
25+
context: .
26+
push: false

‎.github/workflows/release-project.yml‎

Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
1+
# SPDX-FileCopyrightText: 2021 Alliander N.V.
2+
#
3+
# SPDX-License-Identifier: Apache-2.0
4+
5+
name: Release Project
6+
7+
on:
8+
release:
9+
types: [released]
10+
11+
jobs:
12+
push_to_registry:
13+
name: Build and publish
14+
runs-on: ubuntu-latest
15+
steps:
16+
- name: Check out the repo
17+
uses: actions/checkout@v2
18+
- name: Extract tag name
19+
id: extract_tagname
20+
shell: bash
21+
# Extra the tagname form the git reference, value of GITHUB_REF will be something like refs/tags/<tag_name>.
22+
run: echo "##[set-output name=tagname;]$(echo ${GITHUB_REF##*/})"
23+
- name: Use Node.js 14.x
24+
uses: actions/setup-node@v1
25+
with:
26+
node-version: '14.x'
27+
- name: Build application with npm
28+
run: |
29+
npm ci
30+
npm run-script build
31+
- name: Login to Docker Hub
32+
uses: docker/login-action@v1
33+
with:
34+
username: ${{ secrets.DOCKER_HUB_USERNAME }}
35+
password: ${{ secrets.DOCKER_HUB_PASSWORD }}
36+
- name: Build and push docker image to Docker Hub
37+
uses: docker/build-push-action@v2
38+
with:
39+
# Set the context to use the current directory and not execute it's own git checkout.
40+
context: .
41+
push: true
42+
# Tag the images using the tagname and also latest.
43+
tags: |
44+
lfenergycompas/compas-open-scd:${{ steps.extract_tagname.outputs.tagname }}
45+
lfenergycompas/compas-open-scd:latest

‎Dockerfile‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
FROM nginx:latest
2+
COPY build/. /usr/share/nginx/html/

‎README.md‎

Lines changed: 23 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
1-
# `OpenSCD`
1+
# `OpenSCD CoMPAS Edition`
22

3-
[![Build Status](https://travis-ci.org/openscd/open-scd.svg?branch=main)](https://travis-ci.org/openscd/open-scd)
4-
[![FOSSA Status](https://app.fossa.com/api/projects/git%2Bgithub.com%2Fopenscd%2Fopen-scd.svg?type=shield)](https://app.fossa.com/projects/git%2Bgithub.com%2Fopenscd%2Fopen-scd?ref=badge_shield)
5-
[![Built with open-wc recommendations](https://img.shields.io/badge/built%20with-open--wc-blue.svg)](https://github.com/open-wc)
3+
[![NodeJS Build Github Action Status](<https://img.shields.io/github/workflow/status/com-pas/compas-open-scd/NodeJS%20Build?logo=GitHub>)](https://github.com/com-pas/compas-open-scd/actions?query=workflow%3A%22NodeJS+Build%22)
4+
[![LFX Security Status](https://img.shields.io/badge/dynamic/json?color=orange&label=LFX%20Security%20Tool&query=issues%5B%3F%28%40%5B%27repository-name%27%5D%20%3D%3D%20%27compas-open-scd%27%29%5D%5B%27high-open-issues%27%5D&suffix=%20High%20open%20issues&url=https%3A%2F%2Fapi.security.lfx.linuxfoundation.org%2Fv1%2Fproject%2Fe8b6fdf9-2686-44c5-bbaa-6965d04ad3e1%2Fissues)](https://security.lfx.linuxfoundation.org/#/e8b6fdf9-2686-44c5-bbaa-6965d04ad3e1/issues)
5+
[![Slack](https://raw.githubusercontent.com/com-pas/compas-architecture/master/public/LFEnergy-slack.svg)](http://lfenergy.slack.com/)
66

77
Open Substation Communication Designer is an editor for SCL files as described in `IEC 61850-6`.
88

@@ -24,6 +24,25 @@ npm start
2424
- `lint` runs the linter
2525
- `doc` builds markdown documentation in the `doc` directory
2626

27+
### Docker
28+
It's also possible to run OpenSCD CoMPAS Edition as a docker. Of every release a docker image is created and pushed to Docker Hub.
29+
To run the docker container use the following command.
30+
31+
```
32+
docker run -it --rm -d -p 8080:80 --name compas-open-scd lfenergycompas/compas-open-scd:latest
33+
```
34+
Now open a browser and go to "http://localhost:8080". OpenSCD is shown.
35+
36+
### CoMPAS Service
37+
38+
During development, it is sometimes handy to use running backend services, like CIM Mapping or SCL Data Service.
39+
The problem is that these services need an Authorization Header to work. Normally these are injected by a reverse proxy
40+
or something like that.
41+
42+
There is a work-around and that is using the ModHeader Extension of the Browser (Chrome, Firefox, ...).
43+
With this extension the header 'Authorization' can be added with a value 'Bearer <access token>'.
44+
The AccessToken can be retrieved from a running KeyCloak instance.
45+
2746
## License
2847

2948
The [IEC 61850](https://webstore.iec.ch/publication/63319) XSD and NSD code components used are
@@ -33,4 +52,3 @@ This project is licensed under the [Apache License 2.0](LICENSE).
3352

3453
&copy; 2020-2021 OMICRON electronics GmbH
3554

36-
[![FOSSA Status](https://app.fossa.com/api/projects/git%2Bgithub.com%2Fopenscd%2Fopen-scd.svg?type=large)](https://app.fossa.com/projects/git%2Bgithub.com%2Fopenscd%2Fopen-scd?ref=badge_large)

‎__snapshots__/BDA wizarding editing integration.md‎

Lines changed: 43 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -2,12 +2,21 @@
22

33
## `defines a editBDaWizard to edit an existing BDA`
44

5-
#### `looks like the latest snapshot`
5+
#### `looks like the latest snapshot`
66

77
```html
8-
<mwc-dialog defaultaction="close" heading="Edit BDA" open="">
8+
<mwc-dialog
9+
defaultaction="close"
10+
heading="Edit BDA"
11+
open=""
12+
>
913
<div id="wizard-content">
10-
<mwc-button fullwidth="" icon="delete" label="Remove" trailingicon="">
14+
<mwc-button
15+
fullwidth=""
16+
icon="delete"
17+
label="Remove"
18+
trailingicon=""
19+
>
1120
</mwc-button>
1221
<wizard-textfield
1322
dialoginitialfocus=""
@@ -352,7 +361,11 @@
352361
EntryID
353362
</mwc-list-item>
354363
</wizard-select>
355-
<wizard-select fixedmenuposition="" helper="Type" label="type">
364+
<wizard-select
365+
fixedmenuposition=""
366+
helper="Type"
367+
label="type"
368+
>
356369
<mwc-list-item
357370
aria-disabled="true"
358371
class="Struct"
@@ -537,7 +550,12 @@
537550
false
538551
</mwc-list-item>
539552
</wizard-select>
540-
<wizard-select disabled="" helper="Default value" label="Val" nullable="">
553+
<wizard-select
554+
disabled=""
555+
helper="Default value"
556+
label="Val"
557+
nullable=""
558+
>
541559
<mwc-list-item
542560
aria-disabled="false"
543561
aria-selected="false"
@@ -614,14 +632,19 @@
614632
>
615633
</mwc-button>
616634
</mwc-dialog>
635+
617636
```
618637

619638
## `defines a createBDaWizard to create a new BDA element`
620639

621-
#### `looks like the latest snapshot`
640+
#### `looks like the latest snapshot`
622641

623642
```html
624-
<mwc-dialog defaultaction="close" heading="Edit BDA" open="">
643+
<mwc-dialog
644+
defaultaction="close"
645+
heading="Edit BDA"
646+
open=""
647+
>
625648
<div id="wizard-content">
626649
<wizard-textfield
627650
dialoginitialfocus=""
@@ -963,7 +986,11 @@
963986
EntryID
964987
</mwc-list-item>
965988
</wizard-select>
966-
<wizard-select fixedmenuposition="" helper="Type" label="type">
989+
<wizard-select
990+
fixedmenuposition=""
991+
helper="Type"
992+
label="type"
993+
>
967994
<mwc-list-item
968995
aria-disabled="false"
969996
class="Struct"
@@ -1135,7 +1162,12 @@
11351162
false
11361163
</mwc-list-item>
11371164
</wizard-select>
1138-
<wizard-select disabled="" helper="Default value" label="Val" nullable="">
1165+
<wizard-select
1166+
disabled=""
1167+
helper="Default value"
1168+
label="Val"
1169+
nullable=""
1170+
>
11391171
</wizard-select>
11401172
<wizard-textfield
11411173
disabled=""
@@ -1161,4 +1193,6 @@
11611193
>
11621194
</mwc-button>
11631195
</mwc-dialog>
1196+
11641197
```
1198+

‎__snapshots__/Communication Plugin.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,12 +7,12 @@
77
```html
88
<h1>
99
<span style="color: var(--base1)">
10-
[communication.missing]
10+
No subnetwork
1111
</span>
1212
<mwc-fab
1313
extended=""
1414
icon="add"
15-
label="[subnetwork.wizard.title.add]"
15+
label="Add subnetwork"
1616
>
1717
</mwc-fab>
1818
</h1>

‎__snapshots__/DA wizarding editing integration.md‎

Lines changed: 43 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -2,12 +2,21 @@
22

33
## `defines a editDaWizard to edit an existing DA`
44

5-
#### `looks like the latest snapshot`
5+
#### `looks like the latest snapshot`
66

77
```html
8-
<mwc-dialog defaultaction="close" heading="Edit DA" open="">
8+
<mwc-dialog
9+
defaultaction="close"
10+
heading="Edit DA"
11+
open=""
12+
>
913
<div id="wizard-content">
10-
<mwc-button fullwidth="" icon="delete" label="Remove" trailingicon="">
14+
<mwc-button
15+
fullwidth=""
16+
icon="delete"
17+
label="Remove"
18+
trailingicon=""
19+
>
1120
</mwc-button>
1221
<wizard-textfield
1322
dialoginitialfocus=""
@@ -352,7 +361,11 @@
352361
EntryID
353362
</mwc-list-item>
354363
</wizard-select>
355-
<wizard-select fixedmenuposition="" helper="Type" label="type">
364+
<wizard-select
365+
fixedmenuposition=""
366+
helper="Type"
367+
label="type"
368+
>
356369
<mwc-list-item
357370
aria-disabled="true"
358371
class="Struct"
@@ -581,7 +594,12 @@
581594
false
582595
</mwc-list-item>
583596
</wizard-select>
584-
<wizard-select disabled="" helper="Default value" label="Val" nullable="">
597+
<wizard-select
598+
disabled=""
599+
helper="Default value"
600+
label="Val"
601+
nullable=""
602+
>
585603
<mwc-list-item
586604
aria-disabled="false"
587605
aria-selected="false"
@@ -866,14 +884,19 @@
866884
>
867885
</mwc-button>
868886
</mwc-dialog>
887+
869888
```
870889

871890
## `defines a createDaWizard to create a new DA element`
872891

873-
#### `looks like the latest snapshot`
892+
#### `looks like the latest snapshot`
874893

875894
```html
876-
<mwc-dialog defaultaction="close" heading="Edit DA" open="">
895+
<mwc-dialog
896+
defaultaction="close"
897+
heading="Edit DA"
898+
open=""
899+
>
877900
<div id="wizard-content">
878901
<wizard-textfield
879902
dialoginitialfocus=""
@@ -1215,7 +1238,11 @@
12151238
EntryID
12161239
</mwc-list-item>
12171240
</wizard-select>
1218-
<wizard-select fixedmenuposition="" helper="Type" label="type">
1241+
<wizard-select
1242+
fixedmenuposition=""
1243+
helper="Type"
1244+
label="type"
1245+
>
12191246
<mwc-list-item
12201247
aria-disabled="false"
12211248
class="Struct"
@@ -1427,7 +1454,12 @@
14271454
false
14281455
</mwc-list-item>
14291456
</wizard-select>
1430-
<wizard-select disabled="" helper="Default value" label="Val" nullable="">
1457+
<wizard-select
1458+
disabled=""
1459+
helper="Default value"
1460+
label="Val"
1461+
nullable=""
1462+
>
14311463
</wizard-select>
14321464
<wizard-textfield
14331465
disabled=""
@@ -1658,4 +1690,6 @@
16581690
>
16591691
</mwc-button>
16601692
</mwc-dialog>
1693+
16611694
```
1695+

0 commit comments

Comments
 (0)