Skip to content

Commit d08ae74

Browse files
author
Dennis Labordus
committed
Merge branch 'main' into upstream-v0.13
2 parents 4a5549d + 57c184c commit d08ae74

File tree

179 files changed

+10545
-565
lines changed

Some content is hidden

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

179 files changed

+10545
-565
lines changed

‎.github/dependabot.yml‎

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
# SPDX-FileCopyrightText: 2021 Alliander N.V.
2+
#
3+
# SPDX-License-Identifier: Apache-2.0
4+
5+
version: 2
6+
7+
updates:
8+
# Maintain dependencies for GitHub Actions
9+
- package-ecosystem: "github-actions"
10+
directory: "/"
11+
schedule:
12+
interval: "daily"
13+
open-pull-requests-limit: 5

‎.github/release.yml‎

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
# SPDX-FileCopyrightText: 2022 Alliander N.V.
2+
#
3+
# SPDX-License-Identifier: Apache-2.0
4+
5+
changelog:
6+
exclude:
7+
labels:
8+
- wontfix
9+
- duplicate
10+
- invalid
11+
categories:
12+
- title: New Features
13+
labels:
14+
- enhancement
15+
- title: Bugfixes
16+
labels:
17+
- bug
18+
- title: Tooling changes
19+
labels:
20+
- tooling
21+
- title: Dependency updates
22+
labels:
23+
- dependencies
24+
- title: Other Changes
25+
labels:
26+
- "*"

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

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
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, pull_request_target]
8+
9+
jobs:
10+
github-actions-automate-projects:
11+
runs-on: ubuntu-latest
12+
13+
if: ${{ (github.event_name != 'pull_request_target' && github.actor != 'dependabot[bot]') || (github.actor == 'dependabot[bot]' && github.event_name == 'pull_request_target') }}
14+
steps:
15+
- name: add-new-issues-to-repository-based-project-column
16+
uses: docker://takanabe/github-actions-automate-projects:v0.0.1
17+
if: github.event_name == 'issues' && github.event.action == 'opened'
18+
env:
19+
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
20+
GITHUB_PROJECT_URL: https://github.com/com-pas/compas-open-scd/projects/1
21+
GITHUB_PROJECT_COLUMN_NAME: To do
22+
- name: add-new-pull-request-to-repository-based-project-column
23+
uses: docker://takanabe/github-actions-automate-projects:v0.0.1
24+
if: (github.event_name == 'pull_request' || github.event_name == 'pull_request_target') && github.event.action == 'opened'
25+
env:
26+
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
27+
GITHUB_PROJECT_URL: https://github.com/com-pas/compas-open-scd/projects/1
28+
GITHUB_PROJECT_COLUMN_NAME: To do
29+
- name: add-new-issues-to-organization-based-project-column
30+
uses: docker://takanabe/github-actions-automate-projects:v0.0.1
31+
if: github.event_name == 'issues' && github.event.action == 'opened'
32+
env:
33+
GITHUB_TOKEN: ${{ secrets.ORG_GITHUB_ACTION_SECRET }}
34+
GITHUB_PROJECT_URL: https://github.com/orgs/com-pas/projects/1
35+
GITHUB_PROJECT_COLUMN_NAME: To do
36+
- name: add-new-pull-request-to-organization-based-project-column
37+
uses: docker://takanabe/github-actions-automate-projects:v0.0.1
38+
if: (github.event_name == 'pull_request' || github.event_name == 'pull_request_target') && github.event.action == 'opened'
39+
env:
40+
GITHUB_TOKEN: ${{ secrets.ORG_GITHUB_ACTION_SECRET }}
41+
GITHUB_PROJECT_URL: https://github.com/orgs/com-pas/projects/2
42+
GITHUB_PROJECT_COLUMN_NAME: To do

‎.github/workflows/build-and-deploy.yml‎

Lines changed: 0 additions & 30 deletions
This file was deleted.

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

Lines changed: 54 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,54 @@
1+
name: Build Project
2+
3+
on:
4+
push:
5+
branches:
6+
- '**'
7+
pull_request:
8+
branches:
9+
- 'main'
10+
11+
jobs:
12+
build:
13+
name: Build
14+
runs-on: ubuntu-latest
15+
timeout-minutes: 15
16+
17+
steps:
18+
- name: Checkout
19+
uses: actions/checkout@v3
20+
21+
- name: Set up Docker Buildx
22+
id: buildx
23+
if: ${{ github.event_name == 'pull_request' }}
24+
uses: docker/setup-buildx-action@v1
25+
- name: Cache Docker Register
26+
if: ${{ github.event_name == 'pull_request' }}
27+
uses: actions/cache@v3
28+
with:
29+
path: /tmp/.buildx-cache
30+
key: ${{ runner.os }}-buildx-${{ hashFiles('**/Dockerfile') }}
31+
32+
- name: Use Node.js 14.x
33+
uses: actions/setup-node@v3
34+
with:
35+
node-version: '14.x'
36+
37+
- name: Test application with npm
38+
if: ${{ github.event_name == 'push' }}
39+
run: |
40+
npm ci
41+
npm run-script test
42+
43+
- name: Build application with npm
44+
if: ${{ github.event_name == 'pull_request' }}
45+
run: |
46+
npm ci
47+
npm run-script build
48+
- name: Build docker image
49+
if: ${{ github.event_name == 'pull_request' }}
50+
uses: docker/build-push-action@v2
51+
with:
52+
# Set the context to use the current directory and not execute it's own git checkout.
53+
context: .
54+
push: false

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

Lines changed: 56 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,56 @@
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: Checkout
17+
uses: actions/checkout@v3
18+
19+
- name: Set up Docker Buildx
20+
id: buildx
21+
uses: docker/setup-buildx-action@v1
22+
- name: Login to Docker Hub
23+
uses: docker/login-action@v1
24+
with:
25+
username: ${{ secrets.DOCKER_HUB_USERNAME }}
26+
password: ${{ secrets.DOCKER_HUB_TOKEN }}
27+
- name: Cache Docker Register
28+
uses: actions/cache@v3
29+
with:
30+
path: /tmp/.buildx-cache
31+
key: ${{ runner.os }}-buildx-${{ hashFiles('**/Dockerfile') }}
32+
33+
- name: Extract tag name
34+
id: extract_tagname
35+
shell: bash
36+
# Extra the tagname form the git reference, value of GITHUB_REF will be something like refs/tags/<tag_name>.
37+
run: echo "##[set-output name=tagname;]$(echo ${GITHUB_REF##*/})"
38+
- name: Use Node.js 14.x
39+
uses: actions/setup-node@v3
40+
with:
41+
node-version: '14.x'
42+
43+
- name: Build application with npm
44+
run: |
45+
npm ci
46+
npm run-script build
47+
- name: Build and push docker image to Docker Hub
48+
uses: docker/build-push-action@v2
49+
with:
50+
# Set the context to use the current directory and not execute it's own git checkout.
51+
context: .
52+
push: true
53+
# Tag the images using the tagname and also latest.
54+
tags: |
55+
lfenergy/compas-open-scd:${{ steps.extract_tagname.outputs.tagname }}
56+
lfenergy/compas-open-scd:latest

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

Lines changed: 0 additions & 19 deletions
This file was deleted.

‎.github/workflows/test.yml‎

Lines changed: 0 additions & 22 deletions
This file was deleted.

‎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

@@ -46,6 +46,25 @@ We provide the following `npm` scripts for your convenience:
4646
- `npm run doc` builds HTML documentation into the `doc` directory
4747
- `npm run build` builds a deployable version of the project into the `dist` directory
4848

49+
### Docker
50+
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.
51+
To run the docker container use the following command.
52+
53+
```
54+
docker run -it --rm -d -p 8080:80 --name compas-open-scd lfenergy/compas-open-scd:latest
55+
```
56+
Now open a browser and go to "http://localhost:8080". OpenSCD is shown.
57+
58+
### CoMPAS Service
59+
60+
During development, it is sometimes handy to use running backend services, like CIM Mapping or SCL Data Service.
61+
The problem is that these services need an Authorization Header to work. Normally these are injected by a reverse proxy
62+
or something like that.
63+
64+
There is a work-around and that is using the ModHeader Extension of the Browser (Chrome, Firefox, ...).
65+
With this extension the header 'Authorization' can be added with a value 'Bearer <access token>'.
66+
The AccessToken can be retrieved from a running KeyCloak instance.
67+
4968
## License
5069

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

5675
&copy; 2020-2022 OMICRON electronics GmbH
5776

58-
[![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)

0 commit comments

Comments
 (0)