Merge pull request #130 from rancherfederal/deprecate-non-store-stuff

deprecation notices for `dl` and the non-store version of `serve`
This commit is contained in:
Jacob Blain Christen
2023-09-28 11:51:33 -07:00
committed by GitHub
3 changed files with 13 additions and 2 deletions

View File

@@ -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)
* [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.

View File

@@ -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:

View File

@@ -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()
},