Skip to content

Commit

Permalink
Merge pull request #41 from catenax-ng/feat/add_docker_workflow
Browse files Browse the repository at this point in the history
feat: Add docker Workflow
  • Loading branch information
SebastianBezold authored Nov 7, 2023
2 parents e83b915 + aa74ecf commit aa67d74
Show file tree
Hide file tree
Showing 4 changed files with 115 additions and 26 deletions.
76 changes: 76 additions & 0 deletions .github/workflows/docker-hub-build.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,76 @@
# Reference from https://github.com/eclipse-tractusx/app-dashboard/blob/main/.github/workflows/build-image.yaml
# You might want to check the source for recent updates
name: Build - Docker image (SemVer)

on:
push:
branches:
- main
# trigger events for SemVer like tags
tags:
- 'v*.*.*'
- 'v*.*.*-*'
pull_request:
branches:
- main

env:
IMAGE_NAMESPACE: "tractusx"
IMAGE_NAME: "vas-country-risk"

jobs:
docker:
runs-on: ubuntu-latest
permissions:
packages: write

steps:
- name: Checkout
uses: actions/checkout@v3

# Create SemVer or ref tags dependent of trigger event
- name: Docker meta
id: meta
uses: docker/metadata-action@v4
with:
images: |
${{ env.IMAGE_NAMESPACE }}/${{ env.IMAGE_NAME }}
# Automatically prepare image tags; See action docs for more examples.
# semver patter will generate tags like these for example :1 :1.2 :1.2.3
tags: |
type=ref,event=branch
type=ref,event=pr
type=semver,pattern={{version}}
type=semver,pattern={{major}}
type=semver,pattern={{major}}.{{minor}}
- name: DockerHub login
if: github.event_name != 'pull_request'
uses: docker/login-action@v2
with:
# Use existing DockerHub credentials present as secrets
username: ${{ secrets.DOCKER_HUB_USER }}
password: ${{ secrets.DOCKER_HUB_TOKEN }}

- name: Build and push
uses: docker/build-push-action@v3
with:
context: .
push: ${{ github.event_name != 'pull_request' }}
tags: |
${{ steps.meta.outputs.tags }},
${{ env.IMAGE_NAMESPACE }}/${{ env.IMAGE_NAME }}:latest
labels: ${{ steps.meta.outputs.labels }}


# https://github.com/peter-evans/dockerhub-description
# Important step to push image description to DockerHub
- name: Update Docker Hub description
if: github.event_name != 'pull_request'
uses: peter-evans/dockerhub-description@v3
with:
# readme-filepath defaults to toplevel README.md, Only necessary if you have a dedicated file with your 'Notice for docker images'
readme-filepath: DOCKER_NOTICE.md
username: ${{ secrets.DOCKER_HUB_USER }}
password: ${{ secrets.DOCKER_HUB_TOKEN }}
repository: ${{ env.IMAGE_NAMESPACE }}/${{ env.IMAGE_NAME }}
26 changes: 0 additions & 26 deletions .idea/sonarlint/issuestore/index.pb

This file was deleted.

28 changes: 28 additions & 0 deletions DOCKER_NOTICE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
## Notice for Docker image

DockerHub: [https://hub.docker.com/u/tractusx/vas-country-risk](https://hub.docker.com/r/tractusx/vas-country-risk)

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

**VAS Country Risk**

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

- GitHub: https://github.com/eclipse-tractusx/vas-country-risk
- Project home: https://projects.eclipse.org/projects/automotive.tractusx
- Dockerfile: https://github.com/eclipse-tractusx/vas-country-risk/blob/main/Dockerfile
- Project license: [Apache License, Version 2.0](https://github.com/eclipse-tractusx/vas-country-risk/blob/main/LICENSE)


**Used base image**

- Dockerfile: [`nginxinc/nginx-unprivileged:alpine`](https://hub.docker.com/r/nginxinc/nginx-unprivileged)
- GitHub Project: [nginxinc/docker-nginx-unprivileged](https://github.com/nginxinc/docker-nginx-unprivileged)
- DockerHub: [nginxinc/nginx-unprivileged](https://hub.docker.com/r/nginxinc/nginx-unprivileged)


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.

11 changes: 11 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -59,3 +59,14 @@ to install the application.
After that the application should be run with
the `npm start` command.
This will run the application on the following URL: [http://localhost:3000](http://localhost:3000)


## Notice for Docker image

Bellow you can find the information regarding Docker Notice for this application.

* [Vas Country Risk](./DOCKER_NOTICE.md)
## License

Distributed under the Apache 2.0 License.
See [LICENSE](./LICENSE) for more information.

0 comments on commit aa67d74

Please sign in to comment.