diff --git a/cmd/registry/list/list.go b/cmd/registry/list/list.go index 1ea5247d..c5d39865 100644 --- a/cmd/registry/list/list.go +++ b/cmd/registry/list/list.go @@ -11,9 +11,17 @@ import ( func New(runtimeContext *runtime.Context) *cobra.Command { return &cobra.Command{ - Use: "list", - Short: "Lists available workflow registries for the current environment", - Long: `Displays the registries configured for your organization, including type and address.`, + Use: "list", + Short: "Lists available workflow registries for the current environment", + Long: `Displays the registries configured for your organization, including type and address. + +The ID shown for each registry is the value you set in workflow.yaml +under the ` + "`deployment-registry`" + ` key to target that registry, e.g.: + + : + user-workflow: + workflow-name: "my-workflow" + deployment-registry: "private"`, Example: `cre registry list`, Args: cobra.NoArgs, RunE: func(cmd *cobra.Command, args []string) error { @@ -41,6 +49,14 @@ func New(runtimeContext *runtime.Context) *cobra.Command { ui.Line() } + ui.Bold("Targeting a registry") + ui.Dim("Set `deployment-registry` in your workflow.yaml to one of the IDs above:") + ui.Line() + ui.Code(" :") + ui.Code(" user-workflow:") + ui.Code(fmt.Sprintf(" deployment-registry: %q", registries[0].ID)) + ui.Line() + return nil }, } diff --git a/docs/cre_registry_list.md b/docs/cre_registry_list.md index 350ccc24..7872dca8 100644 --- a/docs/cre_registry_list.md +++ b/docs/cre_registry_list.md @@ -6,6 +6,14 @@ Lists available workflow registries for the current environment Displays the registries configured for your organization, including type and address. +The ID shown for each registry is the value you set in workflow.yaml +under the `deployment-registry` key to target that registry, e.g.: + + : + user-workflow: + workflow-name: "my-workflow" + deployment-registry: "private" + ``` cre registry list [optional flags] ```