From c3c5c7e514f4c5145f176c575751a8023b88b006 Mon Sep 17 00:00:00 2001
From: Heikki Hellgren <heikki.hellgren@op.fi>
Date: Thu, 19 Oct 2023 14:27:22 +0300
Subject: [PATCH] chore: add info about entity if tech docs building fails

Signed-off-by: Heikki Hellgren <heikki.hellgren@op.fi>
---
 .changeset/hip-mugs-camp.md                            |  5 +++++
 .../src/service/DocsSynchronizer.test.ts               |  2 +-
 .../techdocs-backend/src/service/DocsSynchronizer.ts   | 10 ++++++++--
 3 files changed, 14 insertions(+), 3 deletions(-)
 create mode 100644 .changeset/hip-mugs-camp.md

diff --git a/.changeset/hip-mugs-camp.md b/.changeset/hip-mugs-camp.md
new file mode 100644
index 0000000000..3413b5ac0a
--- /dev/null
+++ b/.changeset/hip-mugs-camp.md
@@ -0,0 +1,5 @@
+---
+'@backstage/plugin-techdocs-backend': patch
+---
+
+Add info about the entity when tech docs fail to build
diff --git a/plugins/techdocs-backend/src/service/DocsSynchronizer.test.ts b/plugins/techdocs-backend/src/service/DocsSynchronizer.test.ts
index 52a3b82651..ff714eee63 100644
--- a/plugins/techdocs-backend/src/service/DocsSynchronizer.test.ts
+++ b/plugins/techdocs-backend/src/service/DocsSynchronizer.test.ts
@@ -258,7 +258,7 @@ describe('DocsSynchronizer', () => {
       expect(mockResponseHandler.log).toHaveBeenCalledTimes(1);
       expect(mockResponseHandler.log).toHaveBeenCalledWith(
         expect.stringMatching(
-          /error.*: Failed to build the docs page: Some random error/,
+          /error.*: Failed to build the docs page for entity component:default\/test: Some random error/,
         ),
       );
       expect(mockResponseHandler.finish).toHaveBeenCalledTimes(0);
diff --git a/plugins/techdocs-backend/src/service/DocsSynchronizer.ts b/plugins/techdocs-backend/src/service/DocsSynchronizer.ts
index 8456f64a6a..fad915b068 100644
--- a/plugins/techdocs-backend/src/service/DocsSynchronizer.ts
+++ b/plugins/techdocs-backend/src/service/DocsSynchronizer.ts
@@ -15,7 +15,11 @@
  */
 
 import { PluginEndpointDiscovery } from '@backstage/backend-common';
-import { Entity, DEFAULT_NAMESPACE } from '@backstage/catalog-model';
+import {
+  DEFAULT_NAMESPACE,
+  Entity,
+  stringifyEntityRef,
+} from '@backstage/catalog-model';
 import { Config } from '@backstage/config';
 import { assertError, NotFoundError } from '@backstage/errors';
 import { ScmIntegrationRegistry } from '@backstage/integration';
@@ -142,7 +146,9 @@ export class DocsSynchronizer {
       }
     } catch (e) {
       assertError(e);
-      const msg = `Failed to build the docs page: ${e.message}`;
+      const msg = `Failed to build the docs page for entity ${stringifyEntityRef(
+        entity,
+      )}: ${e.message}`;
       taskLogger.error(msg);
       this.logger.error(msg, e);
       error(e);