Merge branch 'main' into edit-resources

Author: lucasgoral

.github/workflows/build.yaml

@@ -35,7 +35,7 @@ jobs:
 
       - name: Upload Cypress Screenshots
         if: always() # Run this step even if tests fail
-        uses: actions/upload-artifact@ea165f8d65b6e75b540449e92b4886f43607fa02 # v4
+        uses: actions/upload-artifact@330a01c490aca151604b8cf639adc76d48f6c5d4 # v5
         with:
           name: cypress-screenshots
           path: |

.github/workflows/main.yaml

@@ -27,6 +27,12 @@ jobs:
       attestations: write
 
     steps:
+      - name: Install Go-Task
+        uses: arduino/setup-task@v2
+        with:
+          version: 3.x
+          repo-token: ${{ secrets.GITHUB_TOKEN }}
+
       - name: Checkout code
         uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5.0.0
 
@@ -64,3 +70,12 @@ jobs:
           annotations: ${{ steps.meta.outputs.annotations }}
           cache-from: type=gha
           cache-to: type=gha,mode=max
+
+      - name: Build OCM component
+        run: task build:ocm
+        env:
+          IMAGE_VERSION: "main"
+          OCM_COMPONENT_VERSION: "v0.0.0-main"
+
+      - name: Publish OCM component
+        run: task publish:ocm OCM_TRANSFER_ARGS="--overwrite"

.github/workflows/on-release.yaml

@@ -7,7 +7,7 @@ on:
   workflow_dispatch:
     inputs:
       nextVersion:
-        description: 'specify the release version in the semver format v[major].[minor].[patch] e.g. v0.0.0'
+        description: "specify the release version in the semver format v[major].[minor].[patch] e.g. v0.0.0"
         required: true
 
 # base permissions for all jobs should be minimal
@@ -71,6 +71,20 @@ jobs:
           sbom: true
           tags: ${{ env.REGISTRY }}/${{ env.IMAGE_NAME }}:latest,${{ env.REGISTRY }}/${{ env.IMAGE_NAME }}:${{ github.event.inputs.nextVersion }}
 
+      - name: Install Go-Task
+        uses: arduino/setup-task@v2
+        with:
+          version: 3.x
+          repo-token: ${{ secrets.GITHUB_TOKEN }}
+
+      - name: Build OCM component
+        run: task build:ocm
+        env:
+          OCM_COMPONENT_VERSION: ${{ github.event.inputs.nextVersion }}
+
+      - name: Publish OCM component
+        run: task publish:ocm
+
       - name: Create Release with autogenerated release notes
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

.gitignore

@@ -12,6 +12,8 @@ dist
 dist-ssr
 *.local
 
+.bin
+
 # Editor directories and files
 .vscode/*
 !.vscode/extensions.json
@@ -33,3 +35,6 @@ public/frontend-config.json
 
 # Sentry Config File
 .env.sentry-build-plugin
+
+# OCM build artifacts
+.ctf/

Taskfile.yml

@@ -0,0 +1,96 @@
+version: '3'
+
+vars:
+  # Variables for Docker image
+  REGISTRY: '{{.REGISTRY | default (print "ghcr.io/openmcp-project") }}'
+  IMAGE_NAME: mcp-ui-frontend
+  IMAGE_TAG: '{{.TAG | default "latest"}}'
+  DOCKER_IMAGE: '{{.REGISTRY}}/{{.IMAGE_NAME}}:{{.IMAGE_TAG}}'
+
+  # Variables for OCM component
+  OCM_COMPONENT_NAME: github.com/openmcp-project/ui
+  OCM_COMPONENT_VERSION: '{{.OCM_COMPONENT_VERSION | default .IMAGE_TAG}}'
+  OCM_PROVIDER: openmcp-project
+  OCM_TARGET_REPO: '{{.OCM_TARGET_REPO | default (print .REGISTRY "/components") }}'
+  OCM_OUTPUT_DIR: '{{.ROOT_DIR}}/.ctf'
+  OCM_DESCRIPTOR: '{{.ROOT_DIR}}/ocm/component-descriptor.yaml'
+
+  ROOT_DIR2: '{{.ROOT_DIR | trimSuffix "/common" | trimSuffix "/hack"}}'
+  LOCALBIN: '{{ env "LOCALBIN" | default ( .LOCALBIN | default (print .ROOT_DIR2 "/.bin") ) }}'
+  OCM: '{{ .OCM | default (print .LOCALBIN "/ocm") }}'
+
+tasks:
+  default:
+    desc: Show available tasks
+    cmds:
+      - task --list
+
+  build:ocm:
+    desc: 'Builds the ocm component. Usage: task build:ocm'
+    deps:
+      - install:ocm
+    cmds:
+      - rm -rf {{.OCM_OUTPUT_DIR}}
+      - |
+        {{.OCM}} add components --create \
+          --lookup {{.OCM_TARGET_REPO}} \
+          --file {{.OCM_OUTPUT_DIR}} \
+          {{.OCM_DESCRIPTOR}} -- \
+          VERSION={{.OCM_COMPONENT_VERSION}} \
+          IMAGE_VERSION={{.IMAGE_VERSION}} \
+          COMPONENT_NAME={{.OCM_COMPONENT_NAME}} \
+          PROVIDER={{.OCM_PROVIDER}}
+    vars:
+      IMAGE_VERSION: '{{.IMAGE_VERSION | default (print .OCM_COMPONENT_VERSION)}}'
+
+  publish:ocm:
+    desc: 'Publishes the ocm component to the registry. Usage: task publish:ocm [OCM_TRANSFER_ARGS="--overwrite"]'
+    deps:
+      - install:ocm
+    cmds:
+      - |
+        {{.OCM}} transfer ctf \
+          {{.OCM_OUTPUT_DIR}} {{.OCM_TARGET_REPO}} {{.OCM_TRANSFER_ARGS}}
+
+  build:image:local:
+    desc: 'Builds the docker image for local testing. Usage: task test:build-image TAG=v-local-test'
+    cmds:
+      - docker build -t {{.DOCKER_IMAGE}} .
+
+  publish:image:local:
+    desc: 'Publishes the docker image for local testing. Usage: task test:publish-image TAG=v-local-test'
+    cmds:
+      - docker push {{.DOCKER_IMAGE}}
+
+  localbin:
+    desc: '  Ensure that the folder specified in LOCALBIN exists.'
+    run: once
+    requires:
+      vars:
+        - LOCALBIN
+    status:
+      - test -d {{.LOCALBIN}}
+    cmds:
+      - 'echo "localbin: {{.LOCALBIN}}"'
+      - mkdir -p {{.LOCALBIN}}
+    internal: true
+
+  install:ocm:
+    desc: '  Ensure that the ocm CLI is installed.'
+    run: once
+    requires:
+      vars:
+        - OCM
+    deps:
+      - localbin
+    status:
+      - 'test -x "{{.OCM}}"'
+      - '"{{.OCM}}" --version | grep -q "{{.OCM_VERSION | trimPrefix "v"}}"'
+    vars:
+      # renovate: datasource=github-releases depName=ocm packageName=open-component-model/ocm
+      OCM_VERSION: '{{ env "OCM_VERSION" | default ( .OCM_VERSION | default "v0.30.0" ) }}'
+      tmpdir:
+        sh: 'mktemp -d'
+    cmds:
+      - 'curl -sSfL https://ocm.software/install.sh | OCM_VERSION="{{.OCM_VERSION | trimPrefix "v"}}" bash -s "{{.tmpdir}}"'
+      - 'mv "{{.tmpdir}}/ocm" "{{.OCM}}"'

cypress/support/commands.d.ts

@@ -0,0 +1,16 @@
+declare global {
+  namespace Cypress {
+    interface Chainable<Subject = unknown> {
+      /**
+       * Deep-compares two objects after normalising them with
+       * JSON.stringify/parse (removes proxies, undefined, symbols …).
+       *
+       * @example
+       *   cy.wrap(actual).deepEqualJson(expected)
+       */
+      deepEqualJson(expected: unknown): Chainable<Subject>;
+    }
+  }
+}
+
+export {};

cypress/support/commands.ts

@@ -1,2 +1,9 @@
 import '@ui5/webcomponents-cypress-commands';
-import "../../src/utils/i18n/i18n";
+import '../../src/utils/i18n/i18n';
+
+const toPlain = <T>(o: T): T => JSON.parse(JSON.stringify(o));
+
+Cypress.Commands.add('deepEqualJson', { prevSubject: true }, (subject, expected) => {
+  expect(toPlain(subject)).to.deep.equal(toPlain(expected));
+  return subject;
+});

ocm/component-descriptor.yaml

@@ -0,0 +1,13 @@
+name: ${COMPONENT_NAME}
+version: ${VERSION}
+provider:
+  name: ${PROVIDER}
+sources: []
+componentReferences: []
+resources:
+  - name: mcp-ui-frontend-image
+    type: ociImage
+    version: ${VERSION}
+    access:
+      type: ociArtifact
+      imageReference: ghcr.io/openmcp-project/mcp-ui-frontend:${IMAGE_VERSION}