Skip to content

Commit 83b3072

Browse files
Stef3stStef3st
committed
Merge branch 'main' into release_v0_33_0_6
Signed-off-by: Stef3st <[email protected]>
2 parents 2066e4c + 0703eaa commit 83b3072

File tree

1,054 files changed

+432685
-6026
lines changed

Some content is hidden

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

1,054 files changed

+432685
-6026
lines changed

‎.github/dependabot.yml‎

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
# SPDX-FileCopyrightText: 2022 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
14+
- package-ecosystem: "docker"
15+
directory: "packages/compas-openscd/"
16+
schedule:
17+
interval: "daily"
18+
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: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
# SPDX-FileCopyrightText: 2022 Alliander N.V.
2+
#
3+
# SPDX-License-Identifier: Apache-2.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-organization-based-project-column
16+
if: github.event_name == 'issues' && github.event.action == 'opened'
17+
uses: alex-page/[email protected]
18+
with:
19+
project: CoMPAS Issues Overview Board
20+
column: To do
21+
repo-token: ${{ secrets.ORG_GITHUB_ACTION_SECRET }}
22+
- name: add-new-pull-request-to-organization-based-project-column
23+
if: (github.event_name == 'pull_request' || github.event_name == 'pull_request_target') && github.event.action == 'opened'
24+
uses: alex-page/[email protected]
25+
with:
26+
project: CoMPAS Pull Request Overview Board
27+
column: To do
28+
repo-token: ${{ secrets.ORG_GITHUB_ACTION_SECRET }}

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

Lines changed: 62 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,62 @@
1+
# SPDX-FileCopyrightText: 2022 Alliander N.V.
2+
#
3+
# SPDX-License-Identifier: Apache-2.0
4+
5+
name: Build Project
6+
7+
on:
8+
push:
9+
branches:
10+
- '**'
11+
pull_request:
12+
branches:
13+
- 'main'
14+
15+
jobs:
16+
build:
17+
name: Build
18+
runs-on: ubuntu-latest
19+
timeout-minutes: 45
20+
21+
steps:
22+
- name: Checkout
23+
uses: actions/[email protected]
24+
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: Set up Docker Buildx
33+
id: buildx
34+
if: ${{ github.event_name == 'pull_request' }}
35+
uses: docker/setup-buildx-action@v3
36+
- name: Use Node.js 14.x
37+
uses: actions/setup-node@v4
38+
with:
39+
node-version: '14.x'
40+
41+
- name: Test application with npm
42+
timeout-minutes: 45
43+
if: ${{ github.event_name == 'push' }}
44+
run: |
45+
cd packages/compas-open-scd
46+
npm ci
47+
npm run-script test
48+
49+
- name: Build application with npm
50+
if: ${{ github.event_name == 'pull_request' }}
51+
timeout-minutes: 45
52+
run: |
53+
cd packages/compas-open-scd
54+
npm ci
55+
npm run-script build
56+
- name: Build docker image
57+
if: ${{ github.event_name == 'pull_request' }}
58+
uses: docker/build-push-action@v5
59+
with:
60+
# Set the context to use the packages/compas-open-scd directory and not execute it's own git checkout.
61+
context: packages/compas-open-scd
62+
push: false

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

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

‎.github/workflows/stale-issues.yml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ jobs:
1616
issues: write
1717

1818
steps:
19-
- uses: actions/stale@v5
19+
- uses: actions/stale@v8
2020
with:
2121
repo-token: ${{ secrets.GITHUB_TOKEN }}
2222

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

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -6,15 +6,15 @@ jobs:
66
runs-on: ubuntu-latest
77
steps:
88
- name: Checkout
9-
uses: actions/checkout@v2.3.1
9+
uses: actions/checkout@v4.1.1
1010

1111
- name: Use Node.js 18.x
12-
uses: actions/setup-node@v1
12+
uses: actions/setup-node@v4
1313
with:
1414
node-version: '18.x'
1515

1616
- name: Install and Build
1717
run: |
18-
cd packages/open-scd
19-
npm clean-install
18+
cd packages/compas-open-scd
19+
npm ci
2020
npm run-script build

‎.github/workflows/test.yml‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -9,15 +9,15 @@ jobs:
99
runs-on: ubuntu-latest
1010
steps:
1111
- name: Checkout
12-
uses: actions/checkout@v2.3.1
12+
uses: actions/checkout@v4.1.1
1313

1414
- name: Use Node.js 18.x
15-
uses: actions/setup-node@v1
15+
uses: actions/setup-node@v4
1616
with:
1717
node-version: '18.x'
1818

1919
- name: Install and Test
2020
run: |
21-
cd packages/open-scd
22-
npm clean-install
21+
cd packages/compas-open-scd
22+
npm ci
2323
npm run-script test

‎README.md‎

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,35 +1,35 @@
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)
6-
[![Slack LF Energy](https://img.shields.io/badge/LF%20Energy%20Slack-%20%23OpenSCD%20chat-purple?logo=slack&color=2aa198&labelColor=6c71c4)](https://lfenergy.slack.com/archives/C03LH7EUP34)
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+
[![CII Best Practices](https://bestpractices.coreinfrastructure.org/projects/5925/badge)](https://bestpractices.coreinfrastructure.org/projects/5925)
5+
[![Slack](https://raw.githubusercontent.com/com-pas/compas-architecture/master/public/LFEnergy-slack.svg)](http://lfenergy.slack.com/)
76

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

10-
> Try it out at [openscd.github.io](https://openscd.github.io)!
9+
> Try it out at [demo.compas.energy](https://demo.compas.energy/)!
1110
1211
Make sure your web browser has enough free memory! If needed, disable plug-ins and close unused browser tabs.
1312

1413
## Installation
1514

16-
In order to install OpenSCD on your local device (only for you), simply visit [openscd.github.io](https://openscd.github.io), click the "Install OpenSCD" button in your address bar (Chrome or Edge on desktop) or click the "Add OpenSCD to home screen" notification in any mobile browser.
17-
18-
In order to install your own instance of OpenSCD on your own webserver (e.g. on your company intranet), simply download [our latest release](https://github.com/openscd/open-scd/releases/latest) (`open-scd.zip` or `open-scd.tar.gz`) and extract the archive contents into the "webroot" directory of your web server.
19-
20-
If you don't have your own webserver but still want your own version of OpenSCD hosted locally (e.g. on a system without an internet connection), you can [use a browser plugin that acts as a local webserver](https://github.com/openscd/open-scd/wiki/Install-OpenSCD#offline) (only for you) instead.
15+
CoMPAS Open Substation Communication Designer is an editor for SCL files as described in `IEC 61850-6`.
2116

17+
CoMPAS OpenSCD is a fork of the [OpenSCD](https://github.com/openscd/open-scd) project. The idea is to add functionality
18+
to use the CoMPAS Backend Service to open and save SCL Files and more.
2219

2320
## Development
2421

2522
This repository is a [↗ monorepo](https://en.wikipedia.org/wiki/Monorepo), made up of several packages.
2623
To find out more about the development of each packages, such as the base distribution or the plugins, please refer to their respective READMEs:
27-
- [open-scd](packages/open-scd/README.md): provides the base distribution available on [openscd.github.io](https://openscd.github.io)
24+
25+
- [open-scd](packages/open-scd/README.md): provides the (upstream) base distribution available on [openscd.github.io](https://openscd.github.io)
26+
- [compas-open-scd](packages/compas-open-scd/README.md): provides the base distribution available on [demo.compas.energy](https://demo.compas.energy)
2827

2928
## Contributing
3029

31-
The easiest way to get in touch is to join the `#open-scd` channel kindly hosted on [the LF Energy Slack server](https://lfenergy.slack.com/archives/C03LH7EUP34).
32-
If you say "hi" there we will be more than happy to help you find your way around this project.
30+
A recommended read for every newcomer to the CoMPAS project is [the CoMPAS Contributing guide](https://com-pas.github.io/contributing/).
31+
32+
You can also get in touch by joining the `#compas` channel hosted on [the LF Energy Slack server](https://lfenergy.slack.com/archives/C01926K9D39).
3333

3434
## Documentation
3535

0 commit comments

Comments
 (0)