Skip to content

Commit 0620aef

Browse files
author
Dennis Labordus
committed
Merge branch 'main' into merge-upstream-071
Signed-off-by: Dennis Labordus <[email protected]>
2 parents 3f023d9 + b802072 commit 0620aef

File tree

101 files changed

+4900
-1820
lines changed

Some content is hidden

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

101 files changed

+4900
-1820
lines changed
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
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
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_TOKEN }}
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+
lfenergy/compas-open-scd:${{ steps.extract_tagname.outputs.tagname }}
45+
lfenergy/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 lfenergy/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.md).
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__/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__/DAType wizards.md

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77
```html
88
<mwc-dialog
99
defaultaction="close"
10-
heading="[datype.wizard.title.add]"
10+
heading="Add DAType"
1111
open=""
1212
>
1313
<div id="wizard-content">
@@ -581,7 +581,7 @@
581581
</mwc-select>
582582
<wizard-textfield
583583
dialoginitialfocus=""
584-
helper="[scl.id]"
584+
helper="ID"
585585
label="id"
586586
maxlength="255"
587587
minlength="1"
@@ -591,7 +591,7 @@
591591
</wizard-textfield>
592592
<wizard-textfield
593593
disabled=""
594-
helper="[scl.desc]"
594+
helper="Description"
595595
label="desc"
596596
nullable=""
597597
pattern="([ -~]|[…]|[ -퟿]|[-�]|[𐀀\-􏿿])*"
@@ -600,15 +600,15 @@
600600
</div>
601601
<mwc-button
602602
dialogaction="close"
603-
label="[cancel]"
603+
label="Cancel"
604604
slot="secondaryAction"
605605
style="--mdc-theme-primary: var(--mdc-theme-error)"
606606
>
607607
</mwc-button>
608608
<mwc-button
609609
dialoginitialfocus=""
610610
icon="add"
611-
label="[add]"
611+
label="Add"
612612
slot="primaryAction"
613613
trailingicon=""
614614
>
@@ -624,20 +624,20 @@
624624
```html
625625
<mwc-dialog
626626
defaultaction="close"
627-
heading="[datype.wizard.title.edit]"
627+
heading="Edit DAType"
628628
open=""
629629
>
630630
<div id="wizard-content">
631631
<mwc-button
632632
fullwidth=""
633633
icon="delete"
634-
label="[remove]"
634+
label="Remove"
635635
trailingicon=""
636636
>
637637
</mwc-button>
638638
<wizard-textfield
639639
dialoginitialfocus=""
640-
helper="[scl.id]"
640+
helper="ID"
641641
label="id"
642642
maxlength="127"
643643
minlength="1"
@@ -647,15 +647,15 @@
647647
</wizard-textfield>
648648
<wizard-textfield
649649
disabled=""
650-
helper="[scl.desc]"
650+
helper="Description"
651651
label="desc"
652652
nullable=""
653653
pattern="([ -~]|[…]|[ -퟿]|[-�]|[𐀀\-􏿿])*"
654654
>
655655
</wizard-textfield>
656656
<mwc-button
657657
icon="playlist_add"
658-
label="[scl.DA]"
658+
label="Data attribute"
659659
slot="graphic"
660660
trailingicon=""
661661
>
@@ -749,15 +749,15 @@
749749
</div>
750750
<mwc-button
751751
dialogaction="close"
752-
label="[cancel]"
752+
label="Cancel"
753753
slot="secondaryAction"
754754
style="--mdc-theme-primary: var(--mdc-theme-error)"
755755
>
756756
</mwc-button>
757757
<mwc-button
758758
dialoginitialfocus=""
759759
icon=""
760-
label="[save]"
760+
label="Save"
761761
slot="primaryAction"
762762
trailingicon=""
763763
>

0 commit comments

Comments
 (0)