openscd / oscd-components Goto Github PK

Currently there are two scripts under the /tools/scripts project in the monorepo that are aimed at automating documentation tasks for all oscd-components. The one called component:doc is not working as it just prints in the terminal the jsdoc comments added to the oscd-components but doesn't really generate any changes to any of the repos and has some commented out code.

This shouldn't be in main. The code should be either completed or removed from our codebase.

Description

As a developer I would like to have automated build, testing and sonarcloud checks in place for every pull request so that when I jump into a review I know that the minimum quality requirements were met by the submitted code

Acceptance Criteria

The .github/ folder contains the following workflows (on both push and pull_request):

• Build components
• Test components
• SonarCloud Code Analysis

A a contributor
I would like to know what pull-request are open
So I can help and/or track the progress

This is especially important with openSCD-core, the plug-ins/code can be in multiple repositories.

Acceptance criteria:

• Overview board on the OpenSCD organization with all (automatically updated) pull-requests from all repositories within the OpenSCD organization
• Public for everyone
• It should not exclude external pull-requests
• Add them to .github as generic github action for the entire organization (https://docs.github.com/en/actions/using-workflows/sharing-workflows-secrets-and-runners-with-your-organization)

Collums:
Pending
Changes requested
Approved
Done

Dones get emptied evey first of the month 0:00 UTC

---

We wait for this first: https://github.com/orgs/openscd/projects/4/views/6?pane=issue&itemId=37844467

As a OpenSCD developer
I would like to have OSCD list framework agnostic
So I don't depend on directy on 3th party component libararies

Create the custom webcomponent OSCD-List,
based on md-list.

The WebComponent should adhere to the styles from oscd-components and export 4 files:
OscdList.ts
oscd-list.ts
OscdListItem.ts
oscd-list-item.ts

Background:
https://github.com/material-components/material-web/blob/v1.0.1/list/internal/list.ts#L45

Open Questions: What listst are we using now?