From 49c759e1c1d020a4ebbb74f7aa12fedee882d653 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Ragnar=20Halld=C3=B3rsson?= Date: Mon, 19 Feb 2024 11:01:28 +0100 Subject: [PATCH] chore(catalog-backend-module-azure): Apply suggestion from code review and improve some wording in README MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Ragnar Halldórsson --- docs/integrations/azure/discovery.md | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) diff --git a/docs/integrations/azure/discovery.md b/docs/integrations/azure/discovery.md index ad454c0ed1..7fbba5228d 100644 --- a/docs/integrations/azure/discovery.md +++ b/docs/integrations/azure/discovery.md @@ -93,6 +93,8 @@ _Note:_ 5. In the window that appears, enter the name of the branch you want to add and click "Add". 6. The added branch will now appear in the "Searchable branches" list. +It may take some time before the branch is indexed and searchable. + As this provider is not one of the default providers, you will first need to install the Azure catalog plugin: @@ -162,12 +164,12 @@ catalog: target: https://dev.azure.com/myorg/myproject/_git/*?path=/src/*/catalog-info.yaml # And optionally provide a specific branch name using the version parameter - type: azure-discovery - target: https://dev.azure.com/myorg/myproject/_git/*?path=/catalog-info.yaml&version=GBdevelopment + target: https://dev.azure.com/myorg/myproject/_git/*?path=/catalog-info.yaml&version=GBtopic/catalog-info ``` Note the `azure-discovery` type, as this is not a regular `url` processor. -When using a custom pattern, the target is composed of six parts: +When using a custom pattern, the target is composed of these parts: - The base instance URL, `https://dev.azure.com` in this case - The organization name which is required, `myorg` in this case @@ -178,4 +180,4 @@ When using a custom pattern, the target is composed of six parts: - The path within each repository to find the catalog YAML file. This will usually be `/catalog-info.yaml`, `/src/*/catalog-info.yaml` or a similar variation for catalog files stored in the root directory of each repository. -- The repository branch to scan which is optional, `development` in this case. The `GB` prefix is mandatory, as this is how Azure DevOps identifies the version as a branch. If omitted, the repo's default branch will be scanned. +- The repository branch to scan which is optional, `topic/catalog-info` in this case. If omitted, the repo's default branch will be scanned. The `GB` prefix is required, as this is how Azure DevOps identifies the version as a branch.