Ability to fetch the README file from a different AZD path, using an annotation on the entity

Signed-off-by: David Roberts <David.Roberts@orbis.com>

plugins/azure-devops-backend/src/api/AzureDevOpsApi.ts

@@ -527,11 +527,12 @@ export class AzureDevOpsApi {
     org: string,
     project: string,
     repo: string,
+    path: string,
   ): Promise<{
     url: string;
     content: string;
   }> {
-    const url = buildEncodedUrl(host, org, project, repo, 'README.md');
+    const url = buildEncodedUrl(host, org, project, repo, path);
     const response = await this.urlReader.readUrl(url);
     const buffer = await response.buffer();
     const content = await replaceReadme(

plugins/azure-devops-backend/src/service/router.ts

@@ -216,12 +216,14 @@ export async function createRouter(
       req.query.host?.toString() ?? config.getString('azureDevOps.host');
     const org =
       req.query.org?.toString() ?? config.getString('azureDevOps.organization');
+    const path = req.query.path?.toString() ?? 'README.md';
     const { projectName, repoName } = req.params;
     const readme = await azureDevOpsApi.getReadme(
       host,
       org,
       projectName,
       repoName,
+      path,
     );
     res.status(200).json(readme);
   });

plugins/azure-devops-common/src/constants.ts

@@ -22,6 +22,8 @@ export const AZURE_DEVOPS_HOST_ORG_ANNOTATION = 'dev.azure.com/host-org';
 /** @public */
 export const AZURE_DEVOPS_PROJECT_ANNOTATION = 'dev.azure.com/project';
 /** @public */
+export const AZURE_DEVOPS_README_ANNOTATION = 'dev.azure.com/readme-path';
+/** @public */
 export const AZURE_DEVOPS_REPO_ANNOTATION = 'dev.azure.com/project-repo';
 /** @public */
 export const AZURE_DEVOPS_DEFAULT_TOP: number = 10;

plugins/azure-devops-common/src/types.ts

@@ -212,6 +212,7 @@ export interface ReadmeConfig {
   repo: string;
   host?: string;
   org?: string;
+  path?: string;
 }
 
 /** @public */

plugins/azure-devops/src/api/AzureDevOpsClient.ts

@@ -189,6 +189,9 @@ export class AzureDevOpsClient implements AzureDevOpsApi {
     if (opts.org) {
       queryString.append('org', opts.org);
     }
+    if (opts.path) {
+      queryString.append('path', opts.path);
+    }
     return await this.get(
       `readme/${encodeURIComponent(opts.project)}/${encodeURIComponent(
         opts.repo,

plugins/azure-devops/src/hooks/useReadme.ts

@@ -30,8 +30,15 @@ export function useReadme(entity: Entity): {
   const api = useApi(azureDevOpsApiRef);
 
   const { value, loading, error } = useAsync(() => {
-    const { project, repo, host, org } = getAnnotationValuesFromEntity(entity);
-    return api.getReadme({ project, repo: repo as string, host, org });
+    const { project, repo, host, org, readmePath } =
+      getAnnotationValuesFromEntity(entity);
+    return api.getReadme({
+      project,
+      repo: repo as string,
+      host,
+      org,
+      path: readmePath,
+    });
   }, [api]);
 
   return {

plugins/azure-devops/src/utils/getAnnotationValuesFromEntity.ts

@@ -18,6 +18,7 @@ import { Entity } from '@backstage/catalog-model';
 import {
   AZURE_DEVOPS_PROJECT_ANNOTATION,
   AZURE_DEVOPS_BUILD_DEFINITION_ANNOTATION,
+  AZURE_DEVOPS_README_ANNOTATION,
   AZURE_DEVOPS_REPO_ANNOTATION,
   AZURE_DEVOPS_HOST_ORG_ANNOTATION,
 } from '@backstage/plugin-azure-devops-common';
@@ -28,6 +29,7 @@ export function getAnnotationValuesFromEntity(entity: Entity): {
   definition?: string;
   host?: string;
   org?: string;
+  readmePath?: string;
 } {
   const hostOrg = getHostOrg(entity.metadata.annotations);
   const projectRepo = getProjectRepo(entity.metadata.annotations);
@@ -35,12 +37,15 @@ export function getAnnotationValuesFromEntity(entity: Entity): {
     entity.metadata.annotations?.[AZURE_DEVOPS_PROJECT_ANNOTATION];
   const definition =
     entity.metadata.annotations?.[AZURE_DEVOPS_BUILD_DEFINITION_ANNOTATION];
+  const readmePath =
+    entity.metadata.annotations?.[AZURE_DEVOPS_README_ANNOTATION];
 
   if (definition) {
     if (project) {
       return {
         project,
         definition,
+        readmePath: readmePath,
         ...hostOrg,
       };
     }
@@ -49,6 +54,7 @@ export function getAnnotationValuesFromEntity(entity: Entity): {
         project: projectRepo.project,
         repo: projectRepo.repo,
         definition,
+        readmePath: readmePath,
         ...hostOrg,
       };
     }
@@ -60,6 +66,7 @@ export function getAnnotationValuesFromEntity(entity: Entity): {
       return {
         project: projectRepo.project,
         repo: projectRepo.repo,
+        readmePath: readmePath,
         ...hostOrg,
       };
     }