From ed3c74ee66654d336d58191c1abceafee1f35db5 Mon Sep 17 00:00:00 2001
From: Sergejs Kostjucenko <85877331+sergejparity@users.noreply.github.com>
Date: Tue, 21 Feb 2023 13:41:51 +0200
Subject: [PATCH] ci: publish docker images description (#522)

* ci publish docker images description

* fix extend refs
---
 .gitlab-ci.yml                | 31 +++++++++++++++++++++++++++++++
 backend/Dockerfile.README.md  |  5 +++++
 frontend/Dockerfile.README.md |  3 +++
 3 files changed, 39 insertions(+)
 create mode 100644 backend/Dockerfile.README.md
 create mode 100644 frontend/Dockerfile.README.md

diff --git a/.gitlab-ci.yml b/.gitlab-ci.yml
index 147c43e..5b7168a 100644
--- a/.gitlab-ci.yml
+++ b/.gitlab-ci.yml
@@ -92,6 +92,25 @@ stages:
   tags:
     - kubernetes-parity-build
 
+.publish-docker-image-description:
+  stage:                  build
+  default:
+    - echo
+  variables:
+    CI_IMAGE:             paritytech/dockerhub-description
+    DOCKERHUB_REPOSITORY: parity/substrate-telemetry-$PRODUCT
+    DOCKER_USERNAME:      $Docker_Hub_User_Parity
+    DOCKER_PASSWORD:      $Docker_Hub_Pass_Parity
+    README_FILEPATH:      $CI_PROJECT_DIR/$PRODUCT/Dockerfile.README.md
+  rules:
+  - if: $CI_COMMIT_REF_NAME == "master"
+    changes:
+    - $PRODUCT/Dockerfile.README.md
+  script:
+    - cd / && sh entrypoint.sh
+  tags:
+    - kubernetes-parity-build
+
 .deploy:                  &deploy
   image:                  paritytech/kubetools:3.5.3
   script:
@@ -141,6 +160,18 @@ build-frontend:
     DOCKERFILE_DIRECTORY: "./frontend/"
   <<:                     *dockerize
 
+publish-backend-docker-image-description:
+  extends:                .publish-docker-image-description
+  variables:
+    PRODUCT:              backend
+    SHORT_DESCRIPTION:    "substrate-backend Docker Image."
+
+publish-frontend-docker-image-description:
+  extends:                .publish-docker-image-description
+  variables:
+    PRODUCT:              frontend
+    SHORT_DESCRIPTION:    "substrate-frontend Docker Image."
+
 # Manually build the docker images and deploy some commit to staging.
 deploy-commit-to-staging:
   variables:
diff --git a/backend/Dockerfile.README.md b/backend/Dockerfile.README.md
new file mode 100644
index 0000000..76f47e4
--- /dev/null
+++ b/backend/Dockerfile.README.md
@@ -0,0 +1,5 @@
+# substrate-telemetry-backend
+
+The backend image contains both the `telemetry_core` and `telemetry_shard` binaries.
+
+### [Documentation](https://github.com/paritytech/substrate-telemetry/blob/master/README.md)
\ No newline at end of file
diff --git a/frontend/Dockerfile.README.md b/frontend/Dockerfile.README.md
new file mode 100644
index 0000000..017a63c
--- /dev/null
+++ b/frontend/Dockerfile.README.md
@@ -0,0 +1,3 @@
+# substrate-telemetry-frontend
+
+### [Documentation](https://github.com/paritytech/substrate-telemetry/blob/master/README.md)
\ No newline at end of file