From 2eab0de64515fbf2f2925b43e04f0a17bd77fa19 Mon Sep 17 00:00:00 2001
From: Nir Gazit <nir.gzt@gmail.com>
Date: Mon, 1 Mar 2021 09:27:01 +0200
Subject: [PATCH] Added comment explaining why emitting optional locations

---
 .../src/ingestion/processors/GithubDiscoveryProcessor.ts       | 3 +++
 1 file changed, 3 insertions(+)

diff --git a/plugins/catalog-backend/src/ingestion/processors/GithubDiscoveryProcessor.ts b/plugins/catalog-backend/src/ingestion/processors/GithubDiscoveryProcessor.ts
index 983db66de4..f5d317444e 100644
--- a/plugins/catalog-backend/src/ingestion/processors/GithubDiscoveryProcessor.ts
+++ b/plugins/catalog-backend/src/ingestion/processors/GithubDiscoveryProcessor.ts
@@ -94,6 +94,9 @@ export class GithubDiscoveryProcessor implements CatalogProcessor {
             type: 'url',
             target: `${repository.url}${catalogPath}`,
           },
+          // Not all locations may actually exist, since the user defined them as a wildcard pattern.
+          // Thus, we omit them as optional and let the downstream processor find them while not outputting
+          // an error if it couldn't.
           true,
         ),
       );