Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[ 16° ] - Release/v2.1.0/legal notice: Added notice.md file and update workflows #201

Merged
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 6 additions & 5 deletions .github/actions/setup-java/action.yaml
Original file line number Diff line number Diff line change
@@ -1,7 +1,8 @@
#################################################################################
# Catena-X - Product Passport Consumer Application
#
# Copyright (c) 2022, 2023 BASF SE, BMW AG, Henkel AG & Co. KGaA
# Copyright (c) 2022, 2024 BASF SE, BMW AG, Henkel AG & Co. KGaA
# Copyright (c) 2023, 2024 Contributors to the Eclipse Foundation
#
# See the NOTICE file(s) distributed with this work for additional
# information regarding copyright ownership.
Expand All @@ -21,13 +22,13 @@
#################################################################################

---
name: "Setup Java 19"
description: "Setup Java 19"
name: "Setup Java"
description: "Setup Java"
runs:
using: "composite"
steps:
- name: Setup Java
uses: actions/setup-java@v4
with:
java-version: '19'
distribution: 'adopt'
java-version: '21'
distribution: 'temurin'
6 changes: 3 additions & 3 deletions .github/workflows/helm-test.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -122,10 +122,10 @@ jobs:

- name: Run chart-testing (install)
run: |
cp deployment/helm/local/storage/pv-data.yaml charts/digital-product-pass/templates/pv-data.yaml
cp deployment/local/storage/pv-data.yaml charts/digital-product-pass/templates/pv-data.yaml
rm charts/digital-product-pass/templates/pvc-data.yaml
cp deployment/helm/local/storage/pvc-data.yaml charts/digital-product-pass/templates/pvc-data.yaml
cp deployment/local/storage/pvc-data.yaml charts/digital-product-pass/templates/pvc-data.yaml
helm repo add bitnami https://charts.bitnami.com/bitnami
helm repo add tractusx https://eclipse-tractusx.github.io/charts/dev
ct install --charts charts/digital-product-pass --helm-extra-set-args "--set=frontend.image.tag=${{ env.TAG }} --set=frontend.image.repository=${{ env.REGISTRY }}/${{ env.FRONTEND_IMAGE}} --set=backend.image.tag=${{ env.TAG }} --set=backend.image.repository=${{ env.REGISTRY }}/${{ env.BACKEND_IMAGE}}"
if: steps.list-changed.outputs.changed == 'true'
if: steps.list-changed.outputs.changed == 'true'
37 changes: 15 additions & 22 deletions .github/workflows/publish-dpp-backend-docker-image.yml
Original file line number Diff line number Diff line change
@@ -1,7 +1,8 @@
#################################################################################
# Catena-X - Product Passport Consumer Application
# Catena-X - Digital Product Pass Application
#
# Copyright (c) 2022, 2023 BASF SE, BMW AG, Henkel AG & Co. KGaA
# Copyright (c) 2022, 2024 BASF SE, BMW AG, Henkel AG & Co. KGaA
# Copyright (c) 2023, 2024 Contributors to the Eclipse Foundation
#
# See the NOTICE file(s) distributed with this work for additional
# information regarding copyright ownership.
Expand Down Expand Up @@ -43,7 +44,6 @@ on:

env:
IMAGE_NAME: 'digital-product-pass-backend'
JAVA_VERSION: 19
REGISTRY: 'ghcr.io'
IMAGE_NAMESPACE: 'tractusx'

Expand All @@ -55,15 +55,18 @@ jobs:

steps:
- name: Checkout repository
uses: actions/checkout@v3
uses: actions/checkout@v4
with:
ref: ${{ github.ref }}

- name: Setup Java
uses: ./.github/actions/setup-java
Dismissed Show dismissed Hide dismissed

# Build actions for GHCR registry
- name: Docker meta for GHCR
id: meta-for-ghcr
if: ${{ github.repository != 'eclipse-tractusx/digital-product-pass' }}
uses: docker/metadata-action@v4
uses: docker/metadata-action@v5
Dismissed Show dismissed Hide dismissed
with:
images: |
${{ env.REGISTRY }}/${{ github.repository }}/${{ env.IMAGE_NAME }}
Expand All @@ -78,16 +81,11 @@ jobs:
# https://github.com/docker/login-action
- name: Log into GHCR registry
if: ${{ github.repository != 'eclipse-tractusx/digital-product-pass' }}
uses: docker/login-action@v2
uses: docker/login-action@v3
Dismissed Show dismissed Hide dismissed
with:
registry: ${{ env.REGISTRY }}
username: ${{ github.actor }}
password: ${{ secrets.GITHUB_TOKEN }}

- uses: actions/setup-java@v3
with:
java-version: '${{ env.JAVA_VERSION }}'
distribution: 'adopt'

# Build Java code with Maven
- name: Build dpp backend with maven for GHCR registry
Expand All @@ -101,7 +99,7 @@ jobs:
- name: Build and push backend for GHCR registry
id: build-and-push-backend-ghcr
if: ${{ github.repository != 'eclipse-tractusx/digital-product-pass' }}
uses: docker/build-push-action@v3
uses: docker/build-push-action@v5
Dismissed Show dismissed Hide dismissed
with:
context: dpp-backend/digitalproductpass
push: true
Expand All @@ -112,7 +110,7 @@ jobs:
- name: Docker meta for Docker Hub
id: meta-for-dockerhub
if: ${{ github.repository == 'eclipse-tractusx/digital-product-pass' }}
uses: docker/metadata-action@v4
uses: docker/metadata-action@v5
Dismissed Show dismissed Hide dismissed
with:
images: |
${{ env.IMAGE_NAMESPACE }}/${{ env.IMAGE_NAME }}
Expand All @@ -127,15 +125,10 @@ jobs:
# https://github.com/docker/login-action
- name: Log into a Docker registry
if: ${{ github.repository == 'eclipse-tractusx/digital-product-pass' }}
uses: docker/login-action@v2
uses: docker/login-action@v3
Dismissed Show dismissed Hide dismissed
with:
username: ${{ secrets.DOCKER_HUB_USER }}
password: ${{ secrets.DOCKER_HUB_TOKEN }}

- uses: actions/setup-java@v3
with:
java-version: '${{ env.JAVA_VERSION }}'
distribution: 'adopt'

# Build Java code with Maven
- name: Build dpp backend with maven for Docker Hub
Expand All @@ -149,7 +142,7 @@ jobs:
- name: Build and push backend for Docker Hub
id: build-and-push-backend-dockerhub
if: ${{ github.repository == 'eclipse-tractusx/digital-product-pass' }}
uses: docker/build-push-action@v3
uses: docker/build-push-action@v5
Dismissed Show dismissed Hide dismissed
with:
context: dpp-backend/digitalproductpass
push: true
Expand All @@ -160,10 +153,10 @@ jobs:
# Important step to push image description to DockerHub
- name: Update Docker Hub description
if: ${{ github.repository == 'eclipse-tractusx/digital-product-pass' }}
uses: peter-evans/dockerhub-description@v3
uses: peter-evans/dockerhub-description@v4
Dismissed Show dismissed Hide dismissed
with:
# readme-filepath defaults to toplevel README.md, Only necessary if you have a dedicated file with your 'Notice for docker images'
# readme-filepath: path/to/dedicated/notice-for-docker-image.md
readme-filepath: docs/notice.md
username: ${{ secrets.DOCKER_HUB_USER }}
password: ${{ secrets.DOCKER_HUB_TOKEN }}
repository: ${{ env.IMAGE_NAMESPACE }}/${{ env.IMAGE_NAME }}
23 changes: 12 additions & 11 deletions .github/workflows/publish-dpp-frontend-docker-image.yml
Original file line number Diff line number Diff line change
@@ -1,7 +1,8 @@
#################################################################################
# Catena-X - Product Passport Consumer Application
# Catena-X - Digital Product Pass Application
#
# Copyright (c) 2022, 2023 BASF SE, BMW AG, Henkel AG & Co. KGaA
# Copyright (c) 2022, 2024 BASF SE, BMW AG, Henkel AG & Co. KGaA
# Copyright (c) 2023, 2024 Contributors to the Eclipse Foundation
#
# See the NOTICE file(s) distributed with this work for additional
# information regarding copyright ownership.
Expand Down Expand Up @@ -56,15 +57,15 @@ jobs:

steps:
- name: Checkout repository
uses: actions/checkout@v3
uses: actions/checkout@v4
with:
ref: ${{ github.ref }}

# Build actions for GHCR registry
- name: Docker meta for GHCR
id: meta-for-ghcr
if: ${{ github.repository != 'eclipse-tractusx/digital-product-pass' }}
uses: docker/metadata-action@v4
uses: docker/metadata-action@v5
Dismissed Show dismissed Hide dismissed
with:
images: |
${{ env.REGISTRY }}/${{ github.repository }}/${{ env.IMAGE_NAME }}
Expand All @@ -79,7 +80,7 @@ jobs:
# https://github.com/docker/login-action
- name: Log into GHCR registry
if: ${{ github.repository != 'eclipse-tractusx/digital-product-pass' }}
uses: docker/login-action@v2
uses: docker/login-action@v3
Dismissed Show dismissed Hide dismissed
with:
registry: ${{ env.REGISTRY }}
username: ${{ github.actor }}
Expand All @@ -90,7 +91,7 @@ jobs:
- name: Build and push frontend for GHCR registry
id: build-and-push-frontend-ghcr
if: ${{ github.repository != 'eclipse-tractusx/digital-product-pass' }}
uses: docker/build-push-action@v3
uses: docker/build-push-action@v5
Dismissed Show dismissed Hide dismissed
with:
push: true
tags: ${{ steps.meta-for-ghcr.outputs.tags }}, ${{ env.REGISTRY }}/${{ github.repository }}/${{ env.IMAGE_NAME }}:latest
Expand All @@ -103,7 +104,7 @@ jobs:
- name: Docker meta for Docker Hub
id: meta-for-dockerhub
if: ${{ github.repository == 'eclipse-tractusx/digital-product-pass' }}
uses: docker/metadata-action@v4
uses: docker/metadata-action@v5
Dismissed Show dismissed Hide dismissed
with:
images: |
${{ env.IMAGE_NAMESPACE }}/${{ env.IMAGE_NAME }}
Expand All @@ -118,7 +119,7 @@ jobs:
# https://github.com/docker/login-action
- name: Log into a Docker registry
if: ${{ github.repository == 'eclipse-tractusx/digital-product-pass' }}
uses: docker/login-action@v2
uses: docker/login-action@v3
Dismissed Show dismissed Hide dismissed
with:
username: ${{ secrets.DOCKER_HUB_USER }}
password: ${{ secrets.DOCKER_HUB_TOKEN }}
Expand All @@ -128,7 +129,7 @@ jobs:
- name: Build and push frontend for Docker Hub
id: build-and-push-frontend-dockerhub
if: ${{ github.repository == 'eclipse-tractusx/digital-product-pass' }}
uses: docker/build-push-action@v3
uses: docker/build-push-action@v5
Dismissed Show dismissed Hide dismissed
with:
push: true
tags: ${{ steps.meta-for-dockerhub.outputs.tags }}, ${{ env.IMAGE_NAMESPACE }}/${{ env.IMAGE_NAME }}:latest
Expand All @@ -142,10 +143,10 @@ jobs:
# Important step to push image description to DockerHub
- name: Update Docker Hub description
if: ${{ github.repository == 'eclipse-tractusx/digital-product-pass' }}
uses: peter-evans/dockerhub-description@v3
uses: peter-evans/dockerhub-description@v4
Dismissed Show dismissed Hide dismissed
with:
# readme-filepath defaults to toplevel README.md, Only necessary if you have a dedicated file with your 'Notice for docker images'
# readme-filepath: path/to/dedicated/notice-for-docker-image.md
readme-filepath: docs/notice.md
username: ${{ secrets.DOCKER_HUB_USER }}
password: ${{ secrets.DOCKER_HUB_TOKEN }}
repository: ${{ env.IMAGE_NAMESPACE }}/${{ env.IMAGE_NAME }}
45 changes: 45 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,51 @@

The changelog format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).

## [released]
## [v2.0.3] - 02-02-2024
## Added
- Added Frameagreement conditions to the provider configuration
- Added Unit Tests for Managers and for Services
- Added changes from version `v1.0.0` to version `v2.0.0` for every component involved
- Added iconMapping for all components involved in DPP `v2.0.0`
- Added multi-language feature that supports currently `EN` and `DE`
- Added back button in the welcome page
- Added `timeToLive` attribute to discovery service model in the dpp-backed
- Added `readOnlyRootFilesystem` to the container security context in helm charts
- Added Serial Part aspect in the drill down components
- Added `notice.md` to include **Notice for docker images** section to be only part of DockerHub description

## Updated
- Cleaned up necessary scripts
-Refactored the DPP and IRS postman collections
- Updated the deployment and testing directory structure and their references in relevant documentation
- Updated license header and deployment directory references in the following readme files:
- Admin guide
- Arc42
- Getting-Started guide
- Updated test directory stricture in dpp-backend
- Updated the app url from [https://materialpass.int.demo.catena-x.net](https://materialpass.int.demo.catena-x.net) to [https://dpp.int.demo.catena-x.net](https://dpp.int.demo.catena-x.net)
- Updated the payloads of asset, policies, contract definition, digital twin and its aspects to align with the DPPTriangle document v1.1.0
- Updated the following frontend content:
- Condition for "commercial.warranty" in General Cards
- Mocked passports
- Loading page translation
- Translation files
- Characteristics component
- Identification component
- Sustainability component
- Typology component
- Updated helm template to provide security context values from helm vaules file
- Updated kics workflow
- Updated user manual, deployment guide
- Updated year 2024 to the license headers
- Updated diagrams to an editable version in `.svg` in business statement readme
- Updated `README.md` and `UNIT_TESTS.md` for the dpp-backend
- Updated versions in docker workflows and setup-java action
- Refactor docker workflows
- Updated **Notice for docker images** section in a main `README.md`


## [released]
## [v2.0.2] - 02-02-2024
## Added
Expand Down
14 changes: 7 additions & 7 deletions DEPENDENCIES_BACKEND
Original file line number Diff line number Diff line change
Expand Up @@ -49,9 +49,9 @@ maven/mavencentral/io.netty/netty-transport/4.1.104.Final, Apache-2.0 AND BSD-3-
maven/mavencentral/io.projectreactor.netty/reactor-netty-core/1.1.14, Apache-2.0, approved, #5946
maven/mavencentral/io.projectreactor.netty/reactor-netty-http/1.1.14, Apache-2.0, approved, #6999
maven/mavencentral/io.projectreactor/reactor-core/3.6.1, Apache-2.0, approved, clearlydefined
maven/mavencentral/io.swagger.core.v3/swagger-annotations-jakarta/2.2.7, Apache-2.0, approved, #5947
maven/mavencentral/io.swagger.core.v3/swagger-core-jakarta/2.2.7, Apache-2.0, approved, #5929
maven/mavencentral/io.swagger.core.v3/swagger-models-jakarta/2.2.7, Apache-2.0, approved, #5919
maven/mavencentral/io.swagger.core.v3/swagger-annotations-jakarta/2.2.8, Apache-2.0, approved, #5947
maven/mavencentral/io.swagger.core.v3/swagger-core-jakarta/2.2.8, Apache-2.0, approved, #5929
maven/mavencentral/io.swagger.core.v3/swagger-models-jakarta/2.2.8, Apache-2.0, approved, #5919
maven/mavencentral/jakarta.activation/jakarta.activation-api/2.1.2, EPL-2.0 OR BSD-3-Clause OR GPL-2.0-only with Classpath-exception-2.0, approved, ee4j.jaf
maven/mavencentral/jakarta.annotation/jakarta.annotation-api/2.1.1, EPL-2.0 OR GPL-2.0-only with Classpath-exception-2.0, approved, ee4j.ca
maven/mavencentral/jakarta.servlet/jakarta.servlet-api/6.0.0, EPL-2.0 OR GPL-2.0-only with Classpath-exception-2.0, approved, ee4j.servlet
Expand Down Expand Up @@ -82,9 +82,9 @@ maven/mavencentral/org.sonarsource.scanner.api/sonar-scanner-api/2.16.2.588, LGP
maven/mavencentral/org.sonarsource.scanner.maven/sonar-maven-plugin/3.9.1.2184, LGPL-3.0-or-later, approved, #6944
maven/mavencentral/org.sonatype.plexus/plexus-cipher/1.4, Apache-2.0, approved, CQ4600
maven/mavencentral/org.sonatype.plexus/plexus-sec-dispatcher/1.4, Apache-2.0, approved, CQ16491
maven/mavencentral/org.springdoc/springdoc-openapi-starter-common/2.0.2, Apache-2.0, approved, #5920
maven/mavencentral/org.springdoc/springdoc-openapi-starter-webmvc-api/2.0.2, Apache-2.0, approved, #5950
maven/mavencentral/org.springdoc/springdoc-openapi-starter-webmvc-ui/2.0.2, Apache-2.0, approved, #5923
maven/mavencentral/org.springdoc/springdoc-openapi-starter-common/2.0.3, Apache-2.0, approved, #5920
maven/mavencentral/org.springdoc/springdoc-openapi-starter-webmvc-api/2.0.3, Apache-2.0, approved, #5950
maven/mavencentral/org.springdoc/springdoc-openapi-starter-webmvc-ui/2.0.3, Apache-2.0, approved, #5923
maven/mavencentral/org.springframework.boot/spring-boot-autoconfigure/3.2.1, Apache-2.0, approved, #11751
maven/mavencentral/org.springframework.boot/spring-boot-starter-data-rest/3.2.1, Apache-2.0, approved, #12594
maven/mavencentral/org.springframework.boot/spring-boot-starter-json/3.2.1, Apache-2.0, approved, #11894
Expand Down Expand Up @@ -127,6 +127,6 @@ maven/mavencentral/org.springframework/spring-tx/6.1.2, Apache-2.0, approved, #1
maven/mavencentral/org.springframework/spring-web/6.1.2, Apache-2.0, approved, #11748
maven/mavencentral/org.springframework/spring-webflux/6.1.2, Apache-2.0, approved, #12593
maven/mavencentral/org.springframework/spring-webmvc/6.1.2, Apache-2.0, approved, #11879
maven/mavencentral/org.webjars/swagger-ui/4.15.5, Apache-2.0 AND MIT, approved, #5921
maven/mavencentral/org.webjars/swagger-ui/4.17.1, Apache-2.0, approved, #13130
maven/mavencentral/org.webjars/webjars-locator-core/0.55, MIT, approved, clearlydefined
maven/mavencentral/org.yaml/snakeyaml/2.0, Apache-2.0 AND (Apache-2.0 OR BSD-3-Clause OR EPL-1.0 OR GPL-2.0-or-later OR LGPL-2.1-or-later), approved, #7275
42 changes: 16 additions & 26 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,9 +36,9 @@ In particular, the appliction is used to access the battery passport data provid

### Software Version
#### Helm Chart Version
<pre id="helm-version"><a href="https://github.com/eclipse-tractusx/digital-product-pass/releases/tag/digital-product-pass-2.0.1">2.0.1</a></pre>
<pre id="helm-version"><a href="https://github.com/eclipse-tractusx/digital-product-pass/releases/tag/digital-product-pass-2.0.3">2.0.3</a></pre>
#### Application Version
<pre id="app-version"><a href="https://github.com/eclipse-tractusx/digital-product-pass/releases/tag/v2.0.1">v2.0.1</a></pre>
<pre id="app-version"><a href="https://github.com/eclipse-tractusx/digital-product-pass/releases/tag/v2.0.3">v2.0.3</a></pre>


## Application Preview
Expand Down Expand Up @@ -88,40 +88,30 @@ For installing the Digital Product Pass application please consult our [Intallat

[Apache-2.0](https://raw.githubusercontent.com/eclipse-tractusx/digital-product-pass/main/LICENSE)

## Notice for Docker images
DockerHub:

## Notice for Docker image

DockerHub:
- https://hub.docker.com/r/tractusx/digital-product-pass-frontend
- https://hub.docker.com/r/tractusx/digital-product-pass-backend

Eclipse Tractus-X product(s) installed within the image:

- GitHub: https://github.com/eclipse-tractusx/digital-product-pass
- Project home: https://projects.eclipse.org/projects/automotive.tractusx
- Dockerfiles:
- Frontend: https://github.com/eclipse-tractusx/digital-product-pass/blob/main/Dockerfile
- Backend: https://github.com/eclipse-tractusx/digital-product-pass/blob/main/dpp-backend/digitalproductpass/Dockerfile
- Project License: [Apache License, Version 2.0](https://raw.githubusercontent.com/eclipse-tractusx/digital-product-pass/main/LICENSE)


**Used base image**
- [node:lts-alpine](https://github.com/nodejs/docker-node)
- [nginxinc/nginx-unprivileged:stable-alpine](https://github.com/nginxinc/docker-nginx-unprivileged/blob/main/Dockerfile-alpine.template)
- [eclipse-temurin:19-alpine](https://github.com/adoptium/containers)
- Official DockerHub pages:
**Base images:**
- DockerHub:
- Node: https://hub.docker.com/_/node
- Nginxinc/nginx-unprivileged: https://hub.docker.com/r/nginxinc/nginx-unprivileged
- Eclipse Temurin: https://hub.docker.com/_/eclipse-temurin
- Eclipse Temurin Project: https://projects.eclipse.org/projects/adoptium.temurin
- Additional information about images:
- Eclipse Temurin: https://hub.docker.com/_/eclipse-temurin

- Dockerfiles:
- [node:lts-alpine](https://github.com/nodejs/docker-node)
- [nginxinc/nginx-unprivileged:stable-alpine](https://github.com/nginxinc/docker-nginx-unprivileged/blob/main/Dockerfile-alpine.template)
- [eclipse-temurin:19-alpine](https://github.com/adoptium/containers)

- GitHub project:
- Node: https://github.com/docker-library/repo-info/tree/master/repos/node
- Nginxinc/nginx-unprivileged: https://github.com/nginxinc/docker-nginx-unprivileged
- nginxinc/docker-nginx-unprivileged: https://github.com/nginxinc/docker-nginx-unprivileged
- Eclipse Temurin: https://github.com/docker-library/repo-info/tree/master/repos/eclipse-temurin

As with all Docker images, these likely also contain other software which may be under other licenses
(such as Bash, etc. from the base distribution, along with any direct or indirect dependencies of the primary software being contained).

As for any pre-built image usage, it is the image user's responsibility to ensure that any use of this image complies with any relevant licenses for all software contained within.

<!-- MARKDOWN LINKS & IMAGES -->
<!-- https://www.markdownguide.org/basic-syntax/#reference-style-links -->
Expand Down
Loading
Loading