Skip to content

Commit

Permalink
docr: Update Repository sub-commands.
Browse files Browse the repository at this point in the history 
- Fix documentation
- Add `--registry` flag to support multi-registry open beta endpoints
  • Loading branch information
@rak16
rak16 committed Nov 12, 2024
1 parent 94e8962 commit ed343b9
Showing 1 changed file with 91 additions and 27 deletions.
118 changes: 91 additions & 27 deletions commands/registry.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -164,7 +164,8 @@ func Repository() *Command {
Writer, aliasOpt("ls"), displayerType(&displayers.Repository{}),
hiddenCmd(),
)
cmdListRepositories.Example = `The following example lists repositories in a registry named ` + "`" + `example-registry` + "`" + ` and uses the ` + "`" + `--format` + "`" + ` flag to return only the name and update time of each repository: doctl registry repository list example-registry --format Name,UpdatedAt`
addRegistryFlag(cmdListRepositories)
cmdListRepositories.Example = `The following example lists repositories in a registry named ` + "`" + `example-registry` + "`" + ` and uses the ` + "`" + `--format` + "`" + ` flag to return only the name and update time of each repository: doctl registry repository list --format Name,UpdatedAt`

listRepositoriesV2Desc := `Retrieves information about repositories in a registry, including:
- The repository name
Expand All @@ -173,14 +174,14 @@ func Repository() *Command {
- The number of tags in the repository
- The number of manifests in the repository
`

cmdListRepositoriesV2 := CmdBuilder(
cmd,
RunListRepositoriesV2, "list-v2",
"List repositories for a container registry", listRepositoriesV2Desc,
Writer, aliasOpt("ls2"), displayerType(&displayers.Repository{}),
)
cmdListRepositoriesV2.Example = `The following example lists repositories in a registry named ` + "`" + `example-registry` + "`" + ` and uses the ` + "`" + `--format` + "`" + ` flag to return only the name and update time of each repository: doctl registry repository list-v2 example-registry --format Name,UpdatedAt`
addRegistryFlag(cmdListRepositoriesV2)
cmdListRepositoriesV2.Example = `The following example lists repositories in a registry named ` + "`" + `example-registry` + "`" + ` and uses the ` + "`" + `--format` + "`" + ` flag to return only the name and update time of each repository: doctl registry repository list-v2 --format Name,UpdatedAt`

listRepositoryTagsDesc := `Retrieves information about tags in a repository, including:
- The tag name
Expand All @@ -194,7 +195,8 @@ func Repository() *Command {
"List tags for a repository in a container registry", listRepositoryTagsDesc,
Writer, aliasOpt("lt"), displayerType(&displayers.RepositoryTag{}),
)
cmdListRepositoryTags.Example = `The following example lists tags in a repository named ` + "`" + `example-repository` + "`" + ` in a registry named ` + "`" + `example-registry` + "`" + `. The command also uses the ` + "`" + `--format` + "`" + ` flag to return only the tag name and manifest digest for each tag: doctl registry repository list-tags example-registry/example-repository --format Tag,ManifestDigest`
addRegistryFlag(cmdListRepositoryTags)
cmdListRepositoryTags.Example = `The following example lists tags in a repository named ` + "`" + `example-repository` + "`" + ` in a registry named ` + "`" + `example-registry` + "`" + `. The command also uses the ` + "`" + `--format` + "`" + ` flag to return only the tag name and manifest digest for each tag: doctl registry repository list-tags example-repository --format Tag,ManifestDigest`

deleteTagDesc := "Permanently deletes one or more repository tags."
cmdRunRepositoryDeleteTag := CmdBuilder(
Expand All @@ -206,8 +208,9 @@ func Repository() *Command {
Writer,
aliasOpt("dt"),
)
addRegistryFlag(cmdRunRepositoryDeleteTag)
AddBoolFlag(cmdRunRepositoryDeleteTag, doctl.ArgForce, doctl.ArgShortForce, false, "Delete tag without confirmation prompt")
cmdRunRepositoryDeleteTag.Example = `The following example deletes a tag named ` + "`" + `web` + "`" + ` from a repository named ` + "`" + `example-repository` + "`" + ` in a registry named ` + "`" + `example-registry` + "`" + `: doctl registry repository delete-tag example-registry/example-repository web`
cmdRunRepositoryDeleteTag.Example = `The following example deletes a tag named ` + "`" + `web` + "`" + ` from a repository named ` + "`" + `example-repository` + "`" + ` in a registry named ` + "`" + `example-registry` + "`" + `: doctl registry repository delete-tag example-repository web`

listRepositoryManifests := `Retrieves information about manifests in a repository, including:
- The manifest digest
Expand All @@ -223,6 +226,7 @@ func Repository() *Command {
"List manifests for a repository in a container registry", listRepositoryManifests,
Writer, aliasOpt("lm"), displayerType(&displayers.RepositoryManifest{}),
)
addRegistryFlag(cmdListRepositoryManifests)
cmdListRepositoryManifests.Example = `The following example lists manifests in a repository named ` + "`" + `example-repository` + "`" + `. The command also uses the ` + "`" + `--format` + "`" + ` flag to return only the digest and update time for each manifest: doctl registry repository list-manifests example-repository --format Digest,UpdatedAt`

deleteManifestDesc := "Permanently deletes one or more repository manifests by digest."
Expand All @@ -235,12 +239,18 @@ func Repository() *Command {
Writer,
aliasOpt("dm"),
)
addRegistryFlag(cmdRunRepositoryDeleteManifest)
AddBoolFlag(cmdRunRepositoryDeleteManifest, doctl.ArgForce, doctl.ArgShortForce, false, "Deletes manifest without confirmation prompt")
cmdRunRepositoryDeleteManifest.Example = `The following example deletes a manifest with digest ` + "`" + `sha256:1234567890abcdef` + "`" + ` from a repository named ` + "`" + `example-repository` + "`" + ` in a registry named ` + "`" + `example-registry` + "`" + `: doctl registry repository delete-manifest example-registry/example-repository sha256:a67c20e45178d90cbe686575719bd81f279b06842dc77521690e292c1eea685`
cmdRunRepositoryDeleteManifest.Example = `The following example deletes a manifest with digest ` + "`" + `sha256:1234567890abcdef` + "`" + ` from a repository named ` + "`" + `example-repository` + "`" + ` in a registry named ` + "`" + `example-registry` + "`" + `: doctl registry repository delete-manifest example-repository sha256:a67c20e45178d90cbe686575719bd81f279b06842dc77521690e292c1eea685`

return cmd
}

func addRegistryFlag(cmd *Command) {
AddStringFlag(cmd, doctl.ArgRegistry, "", "",
"[Beta] Name of the registry that the repository belongs to. For a list of possible values, use the `doctl registries list` command. This is optional and only needed if you have multiple registries.")
}

// GarbageCollection creates the garbage-collection subcommand
func GarbageCollection() *Command {
cmd := &Command{
Expand Down Expand Up @@ -291,7 +301,9 @@ func GarbageCollection() *Command {
aliasOpt("ga", "g"),
displayerType(&displayers.GarbageCollection{}),
)
cmdGetGarbageCollection.Example = `The following example retrieves the currently-active garbage collection for a registry: doctl registry garbage-collection get-active`
cmdGetGarbageCollection.Example = `The following example retrieves the currently-active garbage collection for a registry: doctl registry garbage-collection get-active
[Beta] The following example retrieves the currently-active garbage collection for a registry named ` + "`" + `example-registry` + "`" + `: doctl registry garbage-collection get-active example-registry`

runListGarbageCollectionsDesc := "Retrieves a list of past garbage collections for a registry. Information about each garbage collection includes:" + gcInfoIncluded
cmdListGarbageCollections := CmdBuilder(
Expand All @@ -304,7 +316,9 @@ func GarbageCollection() *Command {
aliasOpt("ls", "l"),
displayerType(&displayers.GarbageCollection{}),
)
cmdListGarbageCollections.Example = `The following example retrieves a list of past garbage collections for a registry: doctl registry garbage-collection list`
cmdListGarbageCollections.Example = `The following example retrieves a list of past garbage collections for a registry: doctl registry garbage-collection list
[Beta] The following example retrieves retrieves a list of past garbage collections for a registry named ` + "`" + `example-registry` + "`" + `: doctl registry garbage-collection list example-registry`

runCancelGarbageCollectionDesc := "Cancels the currently-active garbage collection for a container registry."
cmdCancelGarbageCollection := CmdBuilder(
Expand All @@ -316,7 +330,9 @@ func GarbageCollection() *Command {
Writer,
aliasOpt("c"),
)
cmdCancelGarbageCollection.Example = `The following example cancels the currently-active garbage collection for a registry: doctl registry garbage-collection cancel`
cmdCancelGarbageCollection.Example = `The following example cancels the garbage collection with the uuid` + "`" + `gc-uuid` + "`" + `for a registry: doctl registry garbage-collection cancel gc-uuid
[Beta] The following example cancels the garbage collection with the uuid ` + "`" + `gc-uuid` + "`" + ` for a registry named ` + "`" + `example-registry` + "`" + `: doctl registry garbage-collection list example-registry`

return cmd
}
Expand Down Expand Up @@ -611,12 +627,20 @@ func RunRegistryLogout(c *CmdConfig) error {

// RunListRepositories lists repositories for the registry
func RunListRepositories(c *CmdConfig) error {
registry, err := c.Registry().Get()
registryName, err := c.Doit.GetString(c.NS, doctl.ArgRegistry)
if err != nil {
return fmt.Errorf("failed to get registry: %w", err)
return err
}

repositories, err := c.Registry().ListRepositories(registry.Name)
if registryName == "" {
registry, err := c.Registry().Get()
if err != nil {
return fmt.Errorf("failed to get registry: %w", err)
}
registryName = registry.Name
}

repositories, err := c.Registry().ListRepositories(registryName)
if err != nil {
return err
}
Expand All @@ -626,12 +650,20 @@ func RunListRepositories(c *CmdConfig) error {

// RunListRepositoriesV2 lists repositories for the registry
func RunListRepositoriesV2(c *CmdConfig) error {
registry, err := c.Registry().Get()
registryName, err := c.Doit.GetString(c.NS, doctl.ArgRegistry)
if err != nil {
return fmt.Errorf("failed to get registry: %w", err)
return err
}

repositories, err := c.Registry().ListRepositoriesV2(registry.Name)
if registryName == "" {
registry, err := c.Registry().Get()
if err != nil {
return fmt.Errorf("failed to get registry: %w", err)
}
registryName = registry.Name
}

repositories, err := c.Registry().ListRepositoriesV2(registryName)
if err != nil {
return err
}
Expand All @@ -646,12 +678,20 @@ func RunListRepositoryTags(c *CmdConfig) error {
return err
}

registry, err := c.Registry().Get()
registryName, err := c.Doit.GetString(c.NS, doctl.ArgRegistry)
if err != nil {
return fmt.Errorf("failed to get registry: %w", err)
return err
}

tags, err := c.Registry().ListRepositoryTags(registry.Name, c.Args[0])
if registryName == "" {
registry, err := c.Registry().Get()
if err != nil {
return fmt.Errorf("failed to get registry: %w", err)
}
registryName = registry.Name
}

tags, err := c.Registry().ListRepositoryTags(registryName, c.Args[0])
if err != nil {
return err
}
Expand All @@ -666,12 +706,20 @@ func RunListRepositoryManifests(c *CmdConfig) error {
return err
}

registry, err := c.Registry().Get()
registryName, err := c.Doit.GetString(c.NS, doctl.ArgRegistry)
if err != nil {
return fmt.Errorf("failed to get registry: %w", err)
return err
}

if registryName == "" {
registry, err := c.Registry().Get()
if err != nil {
return fmt.Errorf("failed to get registry: %w", err)
}
registryName = registry.Name
}

manifests, err := c.Registry().ListRepositoryManifests(registry.Name, c.Args[0])
manifests, err := c.Registry().ListRepositoryManifests(registryName, c.Args[0])
if err != nil {
return err
}
Expand All @@ -690,9 +738,17 @@ func RunRepositoryDeleteTag(c *CmdConfig) error {
return doctl.NewMissingArgsErr(c.NS)
}

registry, err := c.Registry().Get()
registryName, err := c.Doit.GetString(c.NS, doctl.ArgRegistry)
if err != nil {
return fmt.Errorf("failed to get registry: %w", err)
return err
}

if registryName == "" {
registry, err := c.Registry().Get()
if err != nil {
return fmt.Errorf("failed to get registry: %w", err)
}
registryName = registry.Name
}

repository := c.Args[0]
Expand All @@ -704,7 +760,7 @@ func RunRepositoryDeleteTag(c *CmdConfig) error {

var errors []string
for _, tag := range tags {
if err := c.Registry().DeleteTag(registry.Name, repository, tag); err != nil {
if err := c.Registry().DeleteTag(registryName, repository, tag); err != nil {
errors = append(errors, err.Error())
}
}
Expand All @@ -727,9 +783,17 @@ func RunRepositoryDeleteManifest(c *CmdConfig) error {
return doctl.NewMissingArgsErr(c.NS)
}

registry, err := c.Registry().Get()
registryName, err := c.Doit.GetString(c.NS, doctl.ArgRegistry)
if err != nil {
return fmt.Errorf("failed to get registry: %w", err)
return err
}

if registryName == "" {
registry, err := c.Registry().Get()
if err != nil {
return fmt.Errorf("failed to get registry: %w", err)
}
registryName = registry.Name
}

repository := c.Args[0]
Expand All @@ -741,7 +805,7 @@ func RunRepositoryDeleteManifest(c *CmdConfig) error {

var errors []string
for _, digest := range digests {
if err := c.Registry().DeleteManifest(registry.Name, repository, digest); err != nil {
if err := c.Registry().DeleteManifest(registryName, repository, digest); err != nil {
errors = append(errors, err.Error())
}
}
Expand Down

0 comments on commit ed343b9

Please sign in to comment.