PR Feedback

Signed-off-by: R-Beck-2020 <78100403+R-Beck-2020@users.noreply.github.com>

.changeset/wicked-elephants-scream.md

@@ -2,4 +2,4 @@
 '@backstage/plugin-azure-devops': minor
 ---
 
-Prefer dev.azure.com/build-definition annotation when it is provided, as it is more specific than dev.azure.com/project-repo
+Prefer `dev.azure.com/build-definition` annotation when it is provided, as it is more specific than `dev.azure.com/project-repo`. This can also be used as a filter for mono-repos.

plugins/azure-devops/README.md

@@ -61,6 +61,25 @@ spec:
   # ...
 ```
 
+#### Mono repos
+
+If you have multiple entities within a single repo, you will need to specify which pipelines belong to each entity.
+
+```yaml
+dev.azure.com/project-repo: <my-project>/<my-repo>
+dev.azure.com/build-definition: <build-definition-name>
+```
+
+#### Pipeline in different project to repo
+
+If your pipeline is in a different project to the source code, you will need to specify this in the project annotation.
+
+```yaml
+dev.azure.com/project-repo: <project1>/<my-repo>
+dev.azure.com/build-definition: <build-definition-name>
+dev.azure.com/project: <project2>
+```
+
 #### Azure Pipelines Only
 
 If you are only using Azure Pipelines along with a different SCM tool then you can use the following two annotations to see Builds:

plugins/azure-devops/src/hooks/useBuildRuns.test.tsx

@@ -99,7 +99,7 @@ describe('useBuildRuns', () => {
       renderHook(() => useBuildRuns(entity), {
         wrapper: Wrapper,
       }),
-    ).toThrow('"dev.azure.com" annotations are missing');
+    ).toThrow('Expected "dev.azure.com" annotations were not found');
   });
 
   it('should return throw when annotation invalid', async () => {

plugins/azure-devops/src/hooks/useGitTags.test.tsx

@@ -103,7 +103,7 @@ describe('useGitTags', () => {
       renderHook(() => useGitTags(entity), {
         wrapper: Wrapper,
       }),
-    ).toThrow('"dev.azure.com" annotations are missing');
+    ).toThrow('Expected "dev.azure.com" annotations were not found');
   });
 
   it('should return throw when annotation invalid', async () => {

plugins/azure-devops/src/hooks/usePullRequests.test.tsx

@@ -102,7 +102,7 @@ describe('usePullRequests', () => {
       renderHook(() => usePullRequests(entity), {
         wrapper: Wrapper,
       }),
-    ).toThrow('"dev.azure.com" annotations are missing');
+    ).toThrow('Expected "dev.azure.com" annotations were not found');
   });
 
   it('should return throw when annotation invalid', async () => {

plugins/azure-devops/src/hooks/useReadme.test.tsx

@@ -81,7 +81,7 @@ describe('useReadme', () => {
       renderHook(() => useReadme(entity), {
         wrapper: Wrapper,
       }),
-    ).toThrow('"dev.azure.com" annotations are missing');
+    ).toThrow('Expected "dev.azure.com" annotations were not found');
   });
 
   it('should return throw when annotation invalid', async () => {

plugins/azure-devops/src/plugin.test.ts

@@ -69,6 +69,18 @@ describe('azure-devops', () => {
       expect(isAzurePipelinesAvailable(entity)).toBe(true);
     });
 
+    it('should be false when no annotations are present', () => {
+      const entity: Entity = {
+        apiVersion: 'backstage.io/v1alpha1',
+        kind: 'Component',
+        metadata: {
+          namespace: 'default',
+          name: 'sample',
+        },
+      };
+      expect(isAzurePipelinesAvailable(entity)).toBe(false);
+    });
+
     it('should be false when only project annotation is present', () => {
       const entity: Entity = {
         apiVersion: 'backstage.io/v1alpha1',

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

@@ -71,7 +71,7 @@ export function getAnnotationValuesFromEntity(entity: Entity): {
     }
   }
 
-  throw new Error('"dev.azure.com" annotations are missing');
+  throw new Error('Expected "dev.azure.com" annotations were not found');
 }
 
 function getProjectRepo(annotations?: Record<string, string>): {