techdocs: meaningful logs when readTree starts

packages/techdocs-common/src/helpers.ts

@@ -209,17 +209,20 @@ export const getLastCommitTimestamp = async (
 export const getDocFilesFromRepository = async (
   reader: UrlReader,
   entity: Entity,
-  opts?: { etag?: string },
+  opts?: { etag?: string; logger?: Logger },
 ): Promise<PreparerResponse> => {
   const { target } = parseReferenceAnnotation(
     'backstage.io/techdocs-ref',
     entity,
   );
 
+  opts?.logger?.info(`Reading files from ${target}`);
   // readTree will throw NotModifiedError if etag has not changed.
   const readTreeResponse = await reader.readTree(target, { etag: opts?.etag });
   const preparedDir = await readTreeResponse.dir();
 
+  opts?.logger?.info(`Tree downloaded and stored at ${preparedDir}`);
+
   return {
     preparedDir,
     etag: readTreeResponse.etag,

packages/techdocs-common/src/stages/prepare/url.ts

@@ -35,6 +35,7 @@ export class UrlPreparer implements PreparerBase {
     try {
       return await getDocFilesFromRepository(this.reader, entity, {
         etag: options?.etag,
+        logger: this.logger,
       });
     } catch (error) {
       // NotModifiedError means that etag based cache is still valid.