From 4beb4d420041665e60e327240db01ad49b6eadd9 Mon Sep 17 00:00:00 2001 From: Adam Martin Date: Wed, 27 Sep 2023 09:07:33 -0400 Subject: [PATCH] deprecation notices for dl and non-store serve --- README.md | 8 +++++++- cmd/hauler/cli/download.go | 5 ++++- cmd/hauler/cli/serve.go | 2 ++ 3 files changed, 13 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 59c02204..5cba0035 100644 --- a/README.md +++ b/README.md @@ -25,4 +25,10 @@ For a guided example of all of `haulers` capabilities, check out the [guided exa * [go-containerregistry](https://github.com/google/go-containerregistry) * [oras](https://github.com/oras-project/oras) -* [cosign](https://github.com/sigstore/cosign) \ No newline at end of file +* [cosign](https://github.com/sigstore/cosign) + +## Notices + +*** WARNING: Deprecated Command *** + +The `hauler download (dl)` and `hauler serve (not the store version)` commands are deprecated and will be removed in a future release of Hauler. \ No newline at end of file diff --git a/cmd/hauler/cli/download.go b/cmd/hauler/cli/download.go index 37223f5c..08fee84c 100644 --- a/cmd/hauler/cli/download.go +++ b/cmd/hauler/cli/download.go @@ -12,7 +12,10 @@ func addDownload(parent *cobra.Command) { cmd := &cobra.Command{ Use: "download", Short: "Download OCI content from a registry and populate it on disk", - Long: `Locate OCI content based on it's reference in a compatible registry and download the contents to disk. + Long: `*** WARNING: Deprecated Command *** +The 'download (dl)' command is deprecated and will be removed in a future release of Hauler. + +Locate OCI content based on it's reference in a compatible registry and download the contents to disk. Note that the content type determines it's format on disk. Hauler's built in content types act as follows: diff --git a/cmd/hauler/cli/serve.go b/cmd/hauler/cli/serve.go index 8a386a38..e85d4722 100644 --- a/cmd/hauler/cli/serve.go +++ b/cmd/hauler/cli/serve.go @@ -10,6 +10,8 @@ func addServe(parent *cobra.Command) { cmd := &cobra.Command{ Use: "serve", Short: "Run one or more of hauler's embedded servers types", + Long: `*** WARNING: Deprecated Command *** +The 'serve' command is deprecated and will be removed in a future release of Hauler.`, RunE: func(cmd *cobra.Command, args []string) error { return cmd.Help() },