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 5 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'
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 @@

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

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

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 @@
# 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 @@
- 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 @@
- 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 @@
# 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 @@
- 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 @@
# 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 @@

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 @@
# 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 @@
- 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 @@
- 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 @@
# 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 @@
- 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 @@
# 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 }}
38 changes: 14 additions & 24 deletions README.md
Original file line number Diff line number Diff line change
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
57 changes: 57 additions & 0 deletions docs/notice.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,57 @@
<!--
Catena-X - Digital Product Pass Application

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.

This program and the accompanying materials are made available under the
terms of the Apache License, Version 2.0 which is available at
https://www.apache.org/licenses/LICENSE-2.0.

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND,
either express or implied. See the
License for the specific language govern in permissions and limitations
under the License.

SPDX-License-Identifier: Apache-2.0
-->

## Notice for Docker images
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:
- 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:
- Node: https://github.com/docker-library/repo-info/tree/master/repos/node
- Nginxinc/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.
Loading