Skip to content

Document deployment-registry usage in cre registry list #418

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
ejacquier merged 3 commits into from
May 7, 2026
Merged

Document deployment-registry usage in cre registry list #418

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
cfb182b
update cre registry list to indicate how to use it
ejacquier May 7, 2026
80456b2
gendoc
ejacquier May 7, 2026
39ce107
fix registry id
ejacquier May 7, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 19 additions & 3 deletions cmd/registry/list/list.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.:

<target-name>:
user-workflow:
workflow-name: "my-workflow"
deployment-registry: "private"`,
Example: `cre registry list`,
Args: cobra.NoArgs,
RunE: func(cmd *cobra.Command, args []string) error {
Expand Down Expand Up @@ -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(" <target-name>:")
ui.Code(" user-workflow:")
ui.Code(fmt.Sprintf(" deployment-registry: %q", registries[0].ID))
ui.Line()

return nil
},
}
Expand Down
8 changes: 8 additions & 0 deletions docs/cre_registry_list.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.:

<target-name>:
user-workflow:
workflow-name: "my-workflow"
deployment-registry: "private"

```
cre registry list [optional flags]
```
Expand Down
Loading