From 5190e8d80a9f919f31f515c75f50487b0abd1102 Mon Sep 17 00:00:00 2001
From: Himanshu Mishra <himanshu@orkohunter.net>
Date: Fri, 12 Mar 2021 00:58:41 +0100
Subject: [PATCH] techdocs: Add etag as techdocs metadata type

Signed-off-by: Himanshu Mishra <himanshu@orkohunter.net>
---
 packages/techdocs-common/src/stages/publish/awsS3.test.ts   | 6 ++++--
 .../src/stages/publish/googleStorage.test.ts                | 6 ++++--
 packages/techdocs-common/src/stages/publish/types.ts        | 1 +
 3 files changed, 9 insertions(+), 4 deletions(-)

diff --git a/packages/techdocs-common/src/stages/publish/awsS3.test.ts b/packages/techdocs-common/src/stages/publish/awsS3.test.ts
index 218d3dd88f..d3281c2645 100644
--- a/packages/techdocs-common/src/stages/publish/awsS3.test.ts
+++ b/packages/techdocs-common/src/stages/publish/awsS3.test.ts
@@ -192,13 +192,14 @@ describe('AwsS3Publish', () => {
       mockFs({
         [entityRootDir]: {
           'techdocs_metadata.json':
-            '{"site_name": "backstage", "site_description": "site_content"}',
+            '{"site_name": "backstage", "site_description": "site_content", "etag": "etag"}',
         },
       });
 
       const expectedMetadata: TechDocsMetadata = {
         site_name: 'backstage',
         site_description: 'site_content',
+        etag: 'etag',
       };
       expect(
         await publisher.fetchTechDocsMetadata(entityNameMock),
@@ -213,13 +214,14 @@ describe('AwsS3Publish', () => {
 
       mockFs({
         [entityRootDir]: {
-          'techdocs_metadata.json': `{'site_name': 'backstage', 'site_description': 'site_content'}`,
+          'techdocs_metadata.json': `{'site_name': 'backstage', 'site_description': 'site_content', 'etag': 'etag'}`,
         },
       });
 
       const expectedMetadata: TechDocsMetadata = {
         site_name: 'backstage',
         site_description: 'site_content',
+        etag: 'etag',
       };
       expect(
         await publisher.fetchTechDocsMetadata(entityNameMock),
diff --git a/packages/techdocs-common/src/stages/publish/googleStorage.test.ts b/packages/techdocs-common/src/stages/publish/googleStorage.test.ts
index 10da0d476a..07bc5c06b9 100644
--- a/packages/techdocs-common/src/stages/publish/googleStorage.test.ts
+++ b/packages/techdocs-common/src/stages/publish/googleStorage.test.ts
@@ -193,13 +193,14 @@ describe('GoogleGCSPublish', () => {
       mockFs({
         [entityRootDir]: {
           'techdocs_metadata.json':
-            '{"site_name": "backstage", "site_description": "site_content"}',
+            '{"site_name": "backstage", "site_description": "site_content", "etag": "etag"}',
         },
       });
 
       const expectedMetadata: TechDocsMetadata = {
         site_name: 'backstage',
         site_description: 'site_content',
+        etag: 'etag',
       };
       expect(
         await publisher.fetchTechDocsMetadata(entityNameMock),
@@ -214,13 +215,14 @@ describe('GoogleGCSPublish', () => {
       mockFs({
         [entityRootDir]: {
           'techdocs_metadata.json':
-            "{'site_name': 'backstage', 'site_description': 'site_content'}",
+            "{'site_name': 'backstage', 'site_description': 'site_content', 'etag': 'etag'}",
         },
       });
 
       const expectedMetadata: TechDocsMetadata = {
         site_name: 'backstage',
         site_description: 'site_content',
+        etag: 'etag',
       };
       expect(
         await publisher.fetchTechDocsMetadata(entityNameMock),
diff --git a/packages/techdocs-common/src/stages/publish/types.ts b/packages/techdocs-common/src/stages/publish/types.ts
index f0ecb3cb2b..7d0644ce7c 100644
--- a/packages/techdocs-common/src/stages/publish/types.ts
+++ b/packages/techdocs-common/src/stages/publish/types.ts
@@ -43,6 +43,7 @@ export type PublishResponse = {
 export type TechDocsMetadata = {
   site_name: string;
   site_description: string;
+  etag: string;
 };
 
 /**