Skip to content

Commit

Permalink
Merge branch 'main' into release_v0_33_0_6
Browse files Browse the repository at this point in the history
Signed-off-by: Stef3st <[email protected]>
  • Loading branch information
Stef3st committed Nov 2, 2023
2 parents 2066e4c + 0703eaa commit 83b3072
Show file tree
Hide file tree
Showing 1,054 changed files with 432,685 additions and 6,026 deletions.
18 changes: 18 additions & 0 deletions .github/dependabot.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
# SPDX-FileCopyrightText: 2022 Alliander N.V.
#
# SPDX-License-Identifier: Apache-2.0

version: 2

updates:
# Maintain dependencies for GitHub Actions
- package-ecosystem: "github-actions"
directory: "/"
schedule:
interval: "daily"
open-pull-requests-limit: 5
- package-ecosystem: "docker"
directory: "packages/compas-openscd/"
schedule:
interval: "daily"
open-pull-requests-limit: 5
26 changes: 26 additions & 0 deletions .github/release.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
# SPDX-FileCopyrightText: 2022 Alliander N.V.
#
# SPDX-License-Identifier: Apache-2.0

changelog:
exclude:
labels:
- wontfix
- duplicate
- invalid
categories:
- title: New Features
labels:
- enhancement
- title: Bugfixes
labels:
- bug
- title: Tooling changes
labels:
- tooling
- title: Dependency updates
labels:
- dependencies
- title: Other Changes
labels:
- "*"
28 changes: 28 additions & 0 deletions .github/workflows/automate-projects.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
# SPDX-FileCopyrightText: 2022 Alliander N.V.
#
# SPDX-License-Identifier: Apache-2.0

name: Add issues and pull request to project boards

on: [ issues, pull_request, pull_request_target ]

jobs:
github-actions-automate-projects:
runs-on: ubuntu-latest

if: ${{ (github.event_name != 'pull_request_target' && github.actor != 'dependabot[bot]') || (github.actor == 'dependabot[bot]' && github.event_name == 'pull_request_target') }}
steps:
- name: add-new-issues-to-organization-based-project-column
if: github.event_name == 'issues' && github.event.action == 'opened'
uses: alex-page/[email protected]
with:
project: CoMPAS Issues Overview Board
column: To do
repo-token: ${{ secrets.ORG_GITHUB_ACTION_SECRET }}
- name: add-new-pull-request-to-organization-based-project-column
if: (github.event_name == 'pull_request' || github.event_name == 'pull_request_target') && github.event.action == 'opened'
uses: alex-page/[email protected]
with:
project: CoMPAS Pull Request Overview Board
column: To do
repo-token: ${{ secrets.ORG_GITHUB_ACTION_SECRET }}
62 changes: 62 additions & 0 deletions .github/workflows/build-project.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,62 @@
# SPDX-FileCopyrightText: 2022 Alliander N.V.
#
# SPDX-License-Identifier: Apache-2.0

name: Build Project

on:
push:
branches:
- '**'
pull_request:
branches:
- 'main'

jobs:
build:
name: Build
runs-on: ubuntu-latest
timeout-minutes: 45

steps:
- name: Checkout
uses: actions/[email protected]

- name: Cache Docker Register
if: ${{ github.event_name == 'pull_request' }}
uses: actions/cache@v3
with:
path: /tmp/.buildx-cache
key: ${{ runner.os }}-buildx-${{ hashFiles('**/Dockerfile') }}

- name: Set up Docker Buildx
id: buildx
if: ${{ github.event_name == 'pull_request' }}
uses: docker/setup-buildx-action@v3
- name: Use Node.js 14.x
uses: actions/setup-node@v4
with:
node-version: '14.x'

- name: Test application with npm
timeout-minutes: 45
if: ${{ github.event_name == 'push' }}
run: |
cd packages/compas-open-scd
npm ci
npm run-script test
- name: Build application with npm
if: ${{ github.event_name == 'pull_request' }}
timeout-minutes: 45
run: |
cd packages/compas-open-scd
npm ci
npm run-script build
- name: Build docker image
if: ${{ github.event_name == 'pull_request' }}
uses: docker/build-push-action@v5
with:
# Set the context to use the packages/compas-open-scd directory and not execute it's own git checkout.
context: packages/compas-open-scd
push: false
59 changes: 59 additions & 0 deletions .github/workflows/release-project.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,59 @@
# SPDX-FileCopyrightText: 2022 Alliander N.V.
#
# SPDX-License-Identifier: Apache-2.0

name: Release Project

on:
release:
types: [released]

jobs:
push_to_registry:
name: Build and publish
runs-on: ubuntu-latest
timeout-minutes: 45

steps:
- name: Checkout
uses: actions/[email protected]

- name: Cache Docker Register
uses: actions/cache@v3
with:
path: /tmp/.buildx-cache
key: ${{ runner.os }}-buildx-${{ hashFiles('**/Dockerfile') }}

- name: Extract tag name
id: extract_tagname
shell: bash
# Extra the tagname form the git reference, value of GITHUB_REF will be something like refs/tags/<tag_name>.
run: echo "##[set-output name=tagname;]$(echo ${GITHUB_REF##*/})"
- name: Set up Docker Buildx
id: buildx
uses: docker/setup-buildx-action@v3
- name: Login to Docker Hub
uses: docker/login-action@v3
with:
username: ${{ secrets.DOCKER_HUB_USERNAME }}
password: ${{ secrets.DOCKER_HUB_TOKEN }}
- name: Use Node.js 14.x
uses: actions/setup-node@v4
with:
node-version: '14.x'

- name: Build application with npm
run: |
cd packages/compas-open-scd
npm ci
npm run-script build
- name: Build and push docker image to Docker Hub
uses: docker/build-push-action@v5
with:
# Set the context to use the packages/compas-open-scd directory and not execute it's own git checkout.
context: packages/compas-open-scd
push: true
# Tag the images using the tagname and also latest.
tags: |
lfenergy/compas-open-scd:${{ steps.extract_tagname.outputs.tagname }}
lfenergy/compas-open-scd:latest
2 changes: 1 addition & 1 deletion .github/workflows/stale-issues.yml
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ jobs:
issues: write

steps:
- uses: actions/stale@v5
- uses: actions/stale@v8
with:
repo-token: ${{ secrets.GITHUB_TOKEN }}

Expand Down
8 changes: 4 additions & 4 deletions .github/workflows/test-and-build.yml
Original file line number Diff line number Diff line change
Expand Up @@ -6,15 +6,15 @@ jobs:
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v2.3.1
uses: actions/checkout@v4.1.1

- name: Use Node.js 18.x
uses: actions/setup-node@v1
uses: actions/setup-node@v4
with:
node-version: '18.x'

- name: Install and Build
run: |
cd packages/open-scd
npm clean-install
cd packages/compas-open-scd
npm ci
npm run-script build
8 changes: 4 additions & 4 deletions .github/workflows/test.yml
Original file line number Diff line number Diff line change
Expand Up @@ -9,15 +9,15 @@ jobs:
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v2.3.1
uses: actions/checkout@v4.1.1

- name: Use Node.js 18.x
uses: actions/setup-node@v1
uses: actions/setup-node@v4
with:
node-version: '18.x'

- name: Install and Test
run: |
cd packages/open-scd
npm clean-install
cd packages/compas-open-scd
npm ci
npm run-script test
28 changes: 14 additions & 14 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,35 +1,35 @@
# `OpenSCD`
# `OpenSCD CoMPAS Edition`

[![Build Status](https://travis-ci.org/openscd/open-scd.svg?branch=main)](https://travis-ci.org/openscd/open-scd)
[![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)
[![Built with open-wc recommendations](https://img.shields.io/badge/built%20with-open--wc-blue.svg)](https://github.com/open-wc)
[![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)
[![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)
[![CII Best Practices](https://bestpractices.coreinfrastructure.org/projects/5925/badge)](https://bestpractices.coreinfrastructure.org/projects/5925)
[![Slack](https://raw.githubusercontent.com/com-pas/compas-architecture/master/public/LFEnergy-slack.svg)](http://lfenergy.slack.com/)

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

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

## Installation

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.

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.

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.
CoMPAS Open Substation Communication Designer is an editor for SCL files as described in `IEC 61850-6`.

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

## Development

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 base distribution available on [openscd.github.io](https://openscd.github.io)

- [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

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).
If you say "hi" there we will be more than happy to help you find your way around this project.
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).

## Documentation

Expand Down
Loading

0 comments on commit 83b3072

Please sign in to comment.