Introduce the annotation backstage.io/techdocs-ref: <relative-target> as an alias for backstage.io/techdocs-ref: dir:<relative-target>

Signed-off-by: Dominik Henneke <dominik.henneke@sda-se.com>

plugins/techdocs-backend/package.json

@@ -35,6 +35,7 @@
     "@backstage/catalog-model": "^0.9.0",
     "@backstage/config": "^0.1.5",
     "@backstage/errors": "^0.1.1",
+    "@backstage/integration": "^0.5.8",
     "@backstage/techdocs-common": "^0.6.8",
     "@types/express": "^4.17.6",
     "cross-fetch": "^3.0.6",

plugins/techdocs-backend/src/DocsBuilder/builder.ts

@@ -20,6 +20,7 @@ import {
 } from '@backstage/catalog-model';
 import { Config } from '@backstage/config';
 import { NotModifiedError } from '@backstage/errors';
+import { ScmIntegrationRegistry } from '@backstage/integration';
 import {
   GeneratorBase,
   GeneratorBuilder,
@@ -43,6 +44,7 @@ type DocsBuilderArguments = {
   entity: Entity;
   logger: Logger;
   config: Config;
+  scmIntegrations: ScmIntegrationRegistry;
   logStream?: Writable;
 };
 
@@ -53,6 +55,7 @@ export class DocsBuilder {
   private entity: Entity;
   private logger: Logger;
   private config: Config;
+  private scmIntegrations: ScmIntegrationRegistry;
   private logStream: Writable | undefined;
 
   constructor({
@@ -62,6 +65,7 @@ export class DocsBuilder {
     entity,
     logger,
     config,
+    scmIntegrations,
     logStream,
   }: DocsBuilderArguments) {
     this.preparer = preparers.get(entity);
@@ -70,6 +74,7 @@ export class DocsBuilder {
     this.entity = entity;
     this.logger = logger;
     this.config = config;
+    this.scmIntegrations = scmIntegrations;
     this.logStream = logStream;
   }
 
@@ -166,7 +171,10 @@ export class DocsBuilder {
       path.join(tmpdirResolvedPath, 'techdocs-tmp-'),
     );
 
-    const parsedLocationAnnotation = getLocationForEntity(this.entity);
+    const parsedLocationAnnotation = getLocationForEntity(
+      this.entity,
+      this.scmIntegrations,
+    );
     await this.generator.run({
       inputDir: preparedDir,
       outputDir,

plugins/techdocs-backend/src/service/DocsSynchronizer.test.ts

@@ -19,6 +19,7 @@ import {
   PluginEndpointDiscovery,
 } from '@backstage/backend-common';
 import { ConfigReader } from '@backstage/config';
+import { ScmIntegrations } from '@backstage/integration';
 import {
   GeneratorBuilder,
   PreparerBuilder,
@@ -69,6 +70,7 @@ describe('DocsSynchronizer', () => {
       publisher,
       config: new ConfigReader({}),
       logger: getVoidLogger(),
+      scmIntegrations: ScmIntegrations.fromConfig(new ConfigReader({})),
     });
   });
 

plugins/techdocs-backend/src/service/DocsSynchronizer.ts

@@ -17,6 +17,7 @@
 import { Entity } from '@backstage/catalog-model';
 import { Config } from '@backstage/config';
 import { NotFoundError } from '@backstage/errors';
+import { ScmIntegrationRegistry } from '@backstage/integration';
 import {
   GeneratorBuilder,
   PreparerBuilder,
@@ -36,19 +37,23 @@ export class DocsSynchronizer {
   private readonly publisher: PublisherBase;
   private readonly logger: winston.Logger;
   private readonly config: Config;
+  private readonly scmIntegrations: ScmIntegrationRegistry;
 
   constructor({
     publisher,
     logger,
     config,
+    scmIntegrations,
   }: {
     publisher: PublisherBase;
     logger: winston.Logger;
     config: Config;
+    scmIntegrations: ScmIntegrationRegistry;
   }) {
     this.config = config;
     this.logger = logger;
     this.publisher = publisher;
+    this.scmIntegrations = scmIntegrations;
   }
 
   async doSync({
@@ -94,6 +99,7 @@ export class DocsSynchronizer {
       logger: taskLogger,
       entity,
       config: this.config,
+      scmIntegrations: this.scmIntegrations,
       logStream,
     });
 

plugins/techdocs-backend/src/service/router.ts

@@ -29,6 +29,7 @@ import express, { Response } from 'express';
 import Router from 'express-promise-router';
 import { Knex } from 'knex';
 import { Logger } from 'winston';
+import { ScmIntegrations } from '@backstage/integration';
 import { DocsSynchronizer, DocsSynchronizerSyncOpts } from './DocsSynchronizer';
 
 /**
@@ -79,10 +80,12 @@ export async function createRouter(
   const router = Router();
   const { publisher, config, logger, discovery } = options;
   const catalogClient = new CatalogClient({ discoveryApi: discovery });
+  const scmIntegrations = ScmIntegrations.fromConfig(config);
   const docsSynchronizer = new DocsSynchronizer({
-    publisher: publisher,
-    logger: logger,
-    config: config,
+    publisher,
+    logger,
+    config,
+    scmIntegrations,
   });
 
   router.get('/metadata/techdocs/:namespace/:kind/:name', async (req, res) => {
@@ -126,7 +129,7 @@ export async function createRouter(
         )
       ).json()) as Entity;
 
-      const locationMetadata = getLocationForEntity(entity);
+      const locationMetadata = getLocationForEntity(entity, scmIntegrations);
       res.json({ ...entity, locationMetadata });
     } catch (err) {
       logger.info(