diff --git a/.github/workflows/irs-build.yml b/.github/workflows/irs-build.yml index bf0de1b72c..d60fc56ee3 100644 --- a/.github/workflows/irs-build.yml +++ b/.github/workflows/irs-build.yml @@ -174,6 +174,7 @@ jobs: username: ${{ secrets.DOCKER_HUB_USER }} password: ${{ secrets.DOCKER_HUB_TOKEN }} repository: ${{ env.IMAGE_NAMESPACE }}/${{ env.IMAGE_NAME }} + readme-filepath: ./DOCKER_NOTICE.md trigger-trivy-image-scan: if: >- diff --git a/DOCKER_NOTICE.md b/DOCKER_NOTICE.md new file mode 100644 index 0000000000..445b9f1a4a --- /dev/null +++ b/DOCKER_NOTICE.md @@ -0,0 +1,29 @@ +## Notice for Docker image + +This application provides container images for demonstration purposes. + +DockerHub: https://hub.docker.com/r/tractusx/irs-api + +Eclipse Tractus-X product(s) installed within the image: + +Item-Relationship-Service + +- GitHub: https://github.com/eclipse-tractusx/item-relationship-service +- Project home: https://projects.eclipse.org/projects/automotive.tractusx +- Dockerfile: https://github.com/eclipse-tractusx/item-relationship-service/blob/main/Dockerfile +- Project + license: [Apache License, Version 2.0](https://github.com/eclipse-tractusx/item-relationship-service/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. \ No newline at end of file diff --git a/README.md b/README.md index a34436aa96..7b85fdf5c6 100644 --- a/README.md +++ b/README.md @@ -127,31 +127,9 @@ the [NOTICE](https://github.com/eclipse-tractusx/item-relationship-service/blob/ ## Notice for Docker image -This application provides container images for demonstration purposes. +Bellow you can find the information regarding Docker Notice for this application. -DockerHub: https://hub.docker.com/r/tractusx/irs-api - -Eclipse Tractus-X product(s) installed within the image: - -- GitHub: https://github.com/eclipse-tractusx/item-relationship-service -- Project home: https://projects.eclipse.org/projects/automotive.tractusx -- Dockerfile: https://github.com/eclipse-tractusx/item-relationship-service/blob/main/Dockerfile -- Project - license: [Apache License, Version 2.0](https://github.com/eclipse-tractusx/item-relationship-service/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. +- [Item Relationship Service](./DOCKER_NOTICE.md) ## Contact