feat: convert to be a generic menu plugin template

Author: stee-re

.github/actions/setup-node-env/action.yml

@@ -5,26 +5,10 @@ on:
       - main
 
 jobs:
-  deploy:
-    runs-on: ubuntu-latest
-    steps:
-      - name: Checkout
-        uses: actions/checkout@v4
-
-      - name: Set up Node.js
-        uses: actions/setup-node@v3
-        with:
-          node-version: '22'
-
-      - name: Install dependencies
-        run: npm ci
-
-      - name: Build
-        run: npm run bundle
-
-      - name: Deploy
-        run: |
-          git remote set-url origin https://git:${GITHUB_TOKEN}@github.com/${GITHUB_REPOSITORY}.git
-          npx gh-pages -d dist -u "github-actions <support+actions@github.com>"
-        env:
-          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+  ci-cd:
+    permissions:
+      contents: write
+      pull-requests: write
+    uses: OMICRONEnergyOSS/oscd-gh-workflows/.github/workflows/continuous-deployment.yml@main
+    secrets:
+      gh_token: ${{ secrets.GITHUB_TOKEN }}

.github/workflows/continuous-deployment.yml

@@ -1,78 +1,17 @@
-name: Release
-
+name: Release Please
 on:
   push:
     branches:
       - main
-  workflow_dispatch:
 
 jobs:
-  release-please:
-    runs-on: ubuntu-latest
-    outputs:
-      release_created: ${{ steps.release.outputs.release_created }}
+  release:
     permissions:
       contents: write
-      pull-requests: write
       issues: write
-    steps:
-      - uses: googleapis/release-please-action@v4
-        id: release
-        with:
-          token: ${{ secrets.GITHUB_TOKEN }}
-          config-file: release-please-config.json
-          manifest-file: .release-please-manifest.json
-
-  npm-publish:
-    needs: release-please
-    if: ${{ needs.release-please.outputs.release_created }}
-    runs-on: ubuntu-latest
-    permissions:
-      contents: read
-      id-token: write
-    steps:
-      - uses: actions/checkout@v4
-      - name: Setup Node.js
-        uses: actions/setup-node@v4
-        with:
-          node-version: '22'
-          registry-url: 'https://registry.npmjs.org'
-          cache: 'npm'
-      - name: Install dependencies
-        run: npm ci
-      - name: Build the package
-        run: npm run build
-      - name: Publish to NPMJS.org
-        run: npm publish --provenance --access public
-        env:
-          NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
-
-  upload-release-bundle:
-    needs: release-please
-    if: ${{ needs.release-please.outputs.release_created }}
-    runs-on: ubuntu-latest
-    permissions:
-      contents: write
+      pull-requests: write
       id-token: write
-
-    steps:
-      - uses: actions/checkout@v4
-
-      - name: Setup Node Environment
-        run: npm ci
-
-      - name: Set repository name env var
-        run: echo "REPO_NAME=${GITHUB_REPOSITORY##*/}" >> $GITHUB_ENV
-
-      - name: Build plugin bundle
-        run: npm run bundle
-
-      - name: Create zipped bundle
-        run: |
-          (cd ./dist && zip -r ../${REPO_NAME}.zip .)
-          tar -C ./dist -czvf ${REPO_NAME}.tar.gz ./
-
-      - name: Upload zipped bundle to GitHub release
-        env:
-          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-        run: gh release upload ${{ needs.release-please.outputs.tag_name }} ${REPO_NAME}.zip ${REPO_NAME}.tar.gz
+    uses: OMICRONEnergyOSS/oscd-gh-workflows/.github/workflows/release-please.yml@main
+    secrets:
+      npm_token: ${{ secrets.NPM_TOKEN }}
+      gh_token: ${{ secrets.GITHUB_TOKEN }}

.github/workflows/release-please.yml

@@ -1,20 +1,12 @@
-name: Test
-on: [push, pull_request, workflow_dispatch]
+name: Unit Tests
+on:
+  push:
+    branches:
+      - main
 
 jobs:
   test:
-    runs-on: ubuntu-latest
-    container:
-      image: mcr.microsoft.com/playwright:v1.54.1-noble
-      options: --user 1001
-    steps:
-      - name: Checkout
-        uses: actions/checkout@v4
-
-      - uses: ./.github/actions/setup-node-env
-
-      - name: Build
-        run: npm run-script build
-
-      - name: Run unit tests
-        run: npm run-script test
+    permissions:
+      contents: write
+      pull-requests: write
+    uses: OMICRONEnergyOSS/oscd-gh-workflows/.github/workflows/unit-tests.yml@main

.github/workflows/test.yml

@@ -1,6 +1,6 @@
-[![Tests](https://github.com/OMICRONEnergyOSS/oscd-menu-save/actions/workflows/test.yml/badge.svg)](https://github.com/OMICRONEnergyOSS/oscd-menu-save/actions/workflows/test.yml) ![NPM Version](https://img.shields.io/npm/v/@omicronenergy/oscd-menu-save)
+[![Tests](https://github.com/OMICRONEnergyOSS/oscd-template-menu/actions/workflows/test.yml/badge.svg)](https://github.com/OMICRONEnergyOSS/oscd-template-menu/actions/workflows/test.yml) ![NPM Version](https://img.shields.io/npm/v/@omicronenergy/oscd-template-menu)
 
-# \<oscd-menu-save>
+# \<oscd-template-menu>
 
 This webcomponent follows the [open-wc](https://github.com/open-wc/open-wc) recommendation.
 

README.md

@@ -1,4 +1,4 @@
-<title>oscd-designer demo</title>
+<title>oscd-template-menu demo</title>
 <link
   rel="stylesheet"
   href="https://fonts.googleapis.com/css2?family=Roboto+Mono:wght@300&family=Roboto:wght@300;400;500&display=swap"

demo/index.html

@@ -1,12 +1,12 @@
 import OscdMenuOpen from '@omicronenergy/oscd-menu-open';
 import OscdBackgroundEditV1 from '@omicronenergy/oscd-background-editv1';
 
-import OscdMenuSave from '../oscd-menu-save.js';
+import OscdMenuSave from '../oscd-template-menu.js';
 
 customElements.define('oscd-menu-open', OscdMenuOpen);
 customElements.define('oscd-background-editv1', OscdBackgroundEditV1);
 
-customElements.define('oscd-menu-save', OscdMenuSave);
+customElements.define('oscd-template-menu', OscdMenuSave);
 
 export const plugins = {
   menu: [
@@ -21,7 +21,7 @@ export const plugins = {
       translations: { de: 'Datei speichern' },
       icon: 'save',
       requireDoc: true,
-      tagName: 'oscd-menu-save',
+      tagName: 'oscd-template-menu',
     },
   ],
   editor: [],

demo/plugins.js

@@ -0,0 +1,35 @@
+import { expect, fixture, html } from '@open-wc/testing';
+import OscdTemplateMenu from './oscd-template-menu.js';
+
+customElements.define('oscd-template-menu', OscdTemplateMenu);
+
+const sclXmlDocString = `<?xml version="1.0" encoding="UTF-8"?><SCL version="2007" revision="B" xmlns="http://www.iec.ch/61850/2003/SCL" xmlns:ens1="http://example.org/somePreexistingExtensionNamespace">
+  <Substation ens1:foo="a" name="A1" desc="test substation"></Substation>
+</SCL>`;
+
+describe('oscd-template-menu', () => {
+  let plugin: OscdTemplateMenu;
+
+  beforeEach(async () => {
+    const sclDoc = new DOMParser().parseFromString(
+      sclXmlDocString,
+      'application/xml',
+    );
+    plugin = await fixture(html`<oscd-template-menu></oscd-template-menu>`);
+    plugin.docs = {
+      'test.scd': sclDoc,
+    };
+    plugin.doc = sclDoc;
+    plugin.docName = 'test.scd';
+  });
+
+  afterEach(() => {
+    plugin.remove();
+  });
+
+  it('tests that the plugin works as expected', async () => {
+    await plugin.run();
+    // Add your assertions here
+    expect(plugin.docName).to.equal('test.scd');
+  });
+});