Merge pull request #241 from bci-oss/feature/separate-docker-notice-file

Separate notice file for docker

.github/workflows/publish-image-semantic-hub.yml

@@ -102,4 +102,5 @@ jobs:
         with:
           username: ${{ secrets.DOCKER_HUB_USER }}
           password: ${{ secrets.DOCKER_HUB_TOKEN }}
-          repository: ${{ env.IMAGE_NAMESPACE }}/${{ env.IMAGE_NAME }}
+          repository: ${{ env.IMAGE_NAMESPACE }}/${{ env.IMAGE_NAME }}
+          readme-filepath: ./DOCKER_NOTICE.md

DOCKER_NOTICE.md

@@ -0,0 +1,34 @@
+## Notice for Docker image
+This application provides container images for demonstration purposes.
+
+DockerHub: [Docker.io:tractusx-semantic-hub](https://hub.docker.com/r/tractusx/sldt-semantic-hub).
+
+The Helm chart can be found at the GitHub repository at: [Releases](https://github.com/eclipse-tractusx/sldt-semantic-hub/releases)
+
+Eclipse Tractus-X product(s) installed within the image:
+
+Semantic Hub
+
+- GitHub: https://github.com/eclipse-tractusx/sldt-semantic-hub
+- Project home: https://projects.eclipse.org/projects/automotive.tractusx
+- Dockerfile: https://github.com/eclipse-tractusx/sldt-semantic-hub/blob/main/backend/Dockerfile
+- Project license: [Apache License, Version 2.0](https://github.com/eclipse-tractusx/sldt-semantic-hub/blob/main/LICENSE)
+
+**Used base image**
+- [eclipse-temurin:17-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.
+
+### NOTICE
+
+This work is licensed under the [Apache-2.0](https://www.apache.org/licenses/LICENSE-2.0).
+
+- SPDX-License-Identifier: Apache-2.0
+- SPDX-FileCopyrightText: 2023 Robert Bosch Manufacturing Solutions GmbH
+- SPDX-FileCopyrightText: 2023 Contributors to the Eclipse Foundation
+- Source URL: https://github.com/eclipse-tractusx/sldt-semantic-hub.git

README.md

@@ -41,38 +41,4 @@ To check whether the build was successful, you can start the resulting JAR file
 Run `docker build -t semantic-hub .`
 
 ## Install Instructions
-For detailed instructions please refer to our [INSTALL.md](INSTALL.md)
-
-## Notice for Docker image
-
-This application provides container images for demonstration purposes.
-
-DockerHub: [Docker.io:tractusx-semantic-hub](https://hub.docker.com/r/tractusx/sldt-semantic-hub). <br>
-
-The Helm chart can be found at the GitHub repository at: [Releases](https://github.com/eclipse-tractusx/sldt-semantic-hub/releases)
-
-Eclipse Tractus-X product(s) installed within the image:
-
-- GitHub: https://github.com/eclipse-tractusx/sldt-semantic-hub
-- Project home: https://projects.eclipse.org/projects/automotive.tractusx
-- Dockerfile: https://github.com/eclipse-tractusx/sldt-semantic-hub/blob/main/backend/Dockerfile
-- Project license: [Apache License, Version 2.0](https://github.com/eclipse-tractusx/sldt-semantic-hub/blob/main/LICENSE)
-
-**Used base image**
-- [eclipse-temurin:17-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.
-
-### NOTICE
-
-This work is licensed under the [Apache-2.0](https://www.apache.org/licenses/LICENSE-2.0).
-
-- SPDX-License-Identifier: Apache-2.0
-- SPDX-FileCopyrightText: 2023 Robert Bosch Manufacturing Solutions GmbH
-- SPDX-FileCopyrightText: 2023 Contributors to the Eclipse Foundation
-- Source URL: https://github.com/eclipse-tractusx/sldt-semantic-hub.git
+For detailed instructions please refer to our [INSTALL.md](INSTALL.md)