From 31c872ed7c3b7b59950900a664d1ee4f70ac06a3 Mon Sep 17 00:00:00 2001 From: Jonathan Mezach Date: Tue, 2 May 2023 13:03:30 +0200 Subject: [PATCH] Fix docs Signed-off-by: Jonathan Mezach --- plugins/octopus-deploy/README.md | 20 ++++++++++++++++++-- 1 file changed, 18 insertions(+), 2 deletions(-) diff --git a/plugins/octopus-deploy/README.md b/plugins/octopus-deploy/README.md index 0901163bcf..6039856998 100644 --- a/plugins/octopus-deploy/README.md +++ b/plugins/octopus-deploy/README.md @@ -42,9 +42,9 @@ const cicdContent = ( ) ``` -3. Add `octopus.com/project-id` and optionally an `octopus.com/space-id` annotation in the catalog descriptor file. +3. Add `octopus.com/project-id` annotation in the catalog descriptor file. -To obtain a projects ID you will have to query the Octopus API. You can get the space ID from the projects URL in the octopus deploy UI. In the future we'll add support for using a projects slug as well. +To obtain a projects ID you will have to query the Octopus API. In the future we'll add support for using a projects slug as well. ``` // catalog-info.yaml @@ -58,4 +58,20 @@ spec: type: service ``` +If your project is not part of the default space you can add the space ID to the annotation as a prefix. For example: + +``` +// catalog-info.yaml +apiVersion: backstage.io/v1alpha1 +kind: Component +metadata: + # ... + annotations: + octopus.com/project-id: Spaces-2/Projects-102 +spec: + type: service +``` + +You can get the ID of the space from the URL in the Octopus Deploy UI. + All set, you will be able to see the plugin in action!