Skip to content

Commit

Permalink
deprecation notices for dl and non-store serve
Browse files Browse the repository at this point in the history
  • Loading branch information
amartin120 committed Sep 27, 2023
1 parent 4ed1b0a commit 4beb4d4
Show file tree
Hide file tree
Showing 3 changed files with 13 additions and 2 deletions.
8 changes: 7 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
5 changes: 4 additions & 1 deletion cmd/hauler/cli/download.go
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down
2 changes: 2 additions & 0 deletions cmd/hauler/cli/serve.go
Original file line number Diff line number Diff line change
Expand Up @@ -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()
},
Expand Down

0 comments on commit 4beb4d4

Please sign in to comment.