Merge pull request #997 from catenax-ng/chore/681-separate-docker-ima…

…ges-section chore(documentation): 681 TRG 4.06 separate Docker Notice
catenax-ng · Feb 20, 2024 · 55fe69e · 55fe69e
2 parents 42fe11e + 01fa3e3
commit 55fe69e
Show file tree

Hide file tree

Showing 7 changed files with 53 additions and 25 deletions.
diff --git a/.github/workflows/docker-image-main_backend.yml b/.github/workflows/docker-image-main_backend.yml
@@ -95,4 +95,4 @@ jobs:
           username: ${{ secrets.DOCKER_HUB_USER }}
           password: ${{ secrets.DOCKER_HUB_TOKEN }}
           repository: ${{ env.DOCKER_HUB_REGISTRY_NAMESPACE }}/${{ env.BACKEND_IMAGE_DOCKER_HUB }}
-          readme-filepath: README.md
+          readme-filepath: ./DOCKER_NOTICE.md
diff --git a/.github/workflows/docker-image-main_frontend.yml b/.github/workflows/docker-image-main_frontend.yml
@@ -92,4 +92,4 @@ jobs:
           username: ${{ env.DOCKER_HUB_USER }}
           password: ${{ secrets.DOCKER_HUB_TOKEN }}
           repository: ${{ env.DOCKER_HUB_REGISTRY_NAMESPACE }}/${{ env.FRONTEND_IMAGE_DOCKER_HUB }}
-          readme-filepath: README.md
+          readme-filepath: ./frontend/DOCKER_NOTICE.md
diff --git a/.github/workflows/docker-image-tag-release.yaml b/.github/workflows/docker-image-tag-release.yaml
@@ -95,7 +95,7 @@ jobs:
           username: ${{ secrets.DOCKER_HUB_USER }}
           password: ${{ secrets.DOCKER_HUB_TOKEN }}
           repository: ${{ env.DOCKER_HUB_REGISTRY_NAMESPACE }}/${{ env.FRONTEND_IMAGE_DOCKER_HUB }}
-          readme-filepath: README.md
+          readme-filepath: ./frontend/DOCKER_NOTICE.md
 
   Release-docker-image-backend:
     runs-on: ubuntu-latest
@@ -169,5 +169,5 @@ jobs:
           username: ${{ secrets.DOCKER_HUB_USER }}
           password: ${{ secrets.DOCKER_HUB_TOKEN }}
           repository: ${{ env.DOCKER_HUB_REGISTRY_NAMESPACE }}/${{env.BACKEND_IMAGE_DOCKER_HUB}}
-          readme-filepath: README.md
+          readme-filepath: ./DOCKER_NOTICE.md
 
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -14,6 +14,7 @@ to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 - Endpoint (assets/import/report/{importJobId}) for retrieving import report
 - Added concept #436: intermediate status handling
 - Added add Parts view concept
+- Added separate Docker notices for both front- and backend
 
 ### Changed
 - actions/chache bumped from v3 to v4

diff --git a/DOCKER_NOTICE.md b/DOCKER_NOTICE.md
@@ -0,0 +1,20 @@
+This application provides container images for demonstration purposes.
+
+Eclipse Tractus-X product(s) installed within the image:
+
+DockerHub Backend: https://hub.docker.com/r/tractusx/traceability-foss
+
+- GitHub: https://github.com/eclipse-tractusx/traceability-foss
+- Project home: https://projects.eclipse.org/projects/automotive.tractusx
+- Dockerfile Backend: https://github.com/eclipse-tractusx/traceability-foss/blob/main/Dockerfile
+- Project license: [Apache License, Version 2.0](https://github.com/eclipse-tractusx/traceability-foss/blob/main/LICENSE)
+
+**Used base image**
+- [eclipse-temurin:20-jre-alpine](https://github.com/adoptium/containers)
+- Official Eclipse Temurin DockerHub page: https://hub.docker.com/_/eclipse-temurin
+- Eclipse Temurin Project: https://projects.eclipse.org/projects/adoptium.temurin
+- Additional information about the Eclipse Temurin images: 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.
diff --git a/README.md b/README.md
@@ -158,28 +158,10 @@ or can be viewed in the Swagger UI accessing the url: `{projectBasePath}/api/swa
 
 ## Notice for Docker image
 
-This application provides container images for demonstration purposes.
+Below you can find the information regarding Docker Notice for this application.
 
-Eclipse Tractus-X product(s) installed within the image:
-
-DockerHub Backend: https://hub.docker.com/r/tractusx/traceability-foss
-DockerHub Frontend: https://hub.docker.com/r/tractusx/traceability-foss-frontend
-
-- GitHub: https://github.com/eclipse-tractusx/traceability-foss
-- Project home: https://projects.eclipse.org/projects/automotive.tractusx
-- Dockerfile Backend: https://github.com/eclipse-tractusx/traceability-foss/blob/main/Dockerfile
-- Dockerfile Frontend: https://github.com/eclipse-tractusx/traceability-foss/blob/main/frontend/Dockerfile
-- Project license: [Apache License, Version 2.0](https://github.com/eclipse-tractusx/traceability-foss/blob/main/LICENSE)
-
-**Used base image**
-- [eclipse-temurin:20-jre-alpine](https://github.com/adoptium/containers)
-- Official Eclipse Temurin DockerHub page: https://hub.docker.com/_/eclipse-temurin
-- Eclipse Temurin Project: https://projects.eclipse.org/projects/adoptium.temurin
-- Additional information about the Eclipse Temurin images: 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.
+- [Traceability Backend Docker Notice](https://github.com/eclipse-tractusx/traceability-foss/blob/main/DOCKER_NOTICE.md)
+- [Traceability Frontend Docker Notice](https://github.com/eclipse-tractusx/traceability-foss/blob/main/frontend/DOCKER_NOTICE.md)
 
 ## Contact
 

diff --git a/frontend/DOCKER_NOTICE.md b/frontend/DOCKER_NOTICE.md
@@ -0,0 +1,25 @@
+This application provides container images for demonstration purposes.
+
+Eclipse Tractus-X product(s) installed within the image:
+
+DockerHub Frontend: https://hub.docker.com/r/tractusx/traceability-foss-frontend
+
+- GitHub: https://github.com/eclipse-tractusx/traceability-foss
+- Project home: https://projects.eclipse.org/projects/automotive.tractusx
+- Dockerfile Frontend: https://github.com/eclipse-tractusx/traceability-foss/blob/main/frontend/Dockerfile
+- Project license: [Apache License, Version 2.0](https://github.com/eclipse-tractusx/traceability-foss/blob/main/LICENSE)
+
+**Used base image**
+
+- [node:18-alpine](https://github.com/nodejs/docker-node)
+- Official Node DockerHub page: https://hub.docker.com/_/node/
+- Dockerfile: https://github.com/nodejs/docker-node/blob/main/18/alpine3.18/Dockerfile
+
+
+- [nginxinc/nginx-unprivileged:alpine](https://github.com/nginxinc/docker-nginx)
+- Official nginx DockerHub page: https://hub.docker.com/_/nginx
+- Dockerfile: https://github.com/nginxinc/docker-nginx/blob/master/mainline/alpine/Dockerfile
+
+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.