Merge pull request #1051 from wrighbr/main

Allow for backstage default mkdocs.yaml

.changeset/sharp-crabs-fail.md

@@ -0,0 +1,5 @@
+---
+'@roadiehq/roadie-backstage-entity-validator': patch
+---
+
+Allow for backstage default mkdocs.yaml

utils/roadie-backstage-entity-validator/src/relativeSpaceValidation.js

@@ -21,7 +21,10 @@ const validateTechDocs = async (data, filePath) => {
   }
   const techDocsAnnotation =
     data.metadata.annotations['backstage.io/techdocs-ref'];
-  if (!techDocsAnnotation.includes('dir')) {
+  if (
+    !techDocsAnnotation.includes('dir') ||
+    techDocsAnnotation.match(/^dir:.$/gm)
+  ) {
     return;
   }
 

utils/roadie-backstage-entity-validator/src/validator.test.js

@@ -278,6 +278,32 @@ spec:
       validator.validateFromFile('invalid-resource-entity.yml'),
     ).rejects.toThrow();
   });
+  describe('validateDefaultTechDocs', () => {
+    const defaultVol = {
+      './test-entity.yaml': `
+      apiVersion: backstage.io/v1alpha1
+      kind: Component
+      metadata:
+        name: test-entity
+        description: |
+          Foo bar description
+        annotations:
+          backstage.io/techdocs-ref: dir:.
+      spec:
+        type: service
+        owner: user:dtuite
+        lifecycle: experimental
+      `,
+    };
+    describe('default techdocs annotations is set', () => {
+      it('should use the default mkdocs.yaml', async () => {
+        vol.fromJSON(defaultVol);
+        await expect(
+          validator.validateFromFile('./test-entity.yaml'),
+        ).resolves.toBeUndefined();
+      });
+    });
+  });
   describe('validateTechDocs', () => {
     const defaultVol = {
       './test-entity.yaml': `