search

vmware-tanzu / tanzu-cli

The Tanzu Core CLI project provides the core functionality of the Tanzu CLI. The CLI is based on a plugin architecture where CLI command functionality can be delivered through independently developed plugin binaries
Apache License 2.0
33 stars 22 forks source link

Provide documentation link in upgrade message #727

Closed marckhouzam closed 5 months ago

marckhouzam commented 5 months ago

What this PR does / why we need it

This PR simply adds the printout Please refer to these instructions for upgrading: https://github.com/vmware-tanzu/tanzu-cli/blob/main/docs/quickstart/install.md. whenever the recommended version notification is printed.

Follow-up to #707

Which issue(s) this PR fixes

Fixes # N/A

Describe testing done for PR

Notice the new line: Please refer to these instructions for upgrading... printed:

$ make start-test-central-repo
[...]
$ tz config set env.TANZU_CLI_PLUGIN_DISCOVERY_IMAGE_SIGNATURE_VERIFICATION_SKIP_LIST localhost:9876/tanzu-cli/plugins/central:small
$ tz plugin source update default -u localhost:9876/tanzu-cli/plugins/central:small
[i] Refreshing plugin inventory cache for "localhost:9876/tanzu-cli/plugins/central:small", this will take a few seconds.
[ok] updated discovery source default

$ TANZU_CLI_RECOMMEND_VERSION_DELAY_DAYS=-1 tanzu plugin list
Standalone Plugins
  NAME         DESCRIPTION                                             TARGET      VERSION        STATUS
  accelerator  Manage accelerators in a Kubernetes cluster             kubernetes  v1.8.0         installed
  apps         Applications on Kubernetes                              kubernetes  v0.13.0        installed
  appsv2       Applications on Kubernetes for TAP (SaaS distribution)  kubernetes  v0.2.0-beta.2  installed
  builder      Build Tanzu components                                  global      v1.4.0-test    installed
  cluster      Kubernetes cluster operations                           kubernetes  v0.25.0        installed
  project      View, list and use Tanzu Projects.                      kubernetes  v0.1.0-beta.3  installed
  space        Tanzu space, space profile, and space trait management  kubernetes  v0.1.0-beta.4  installed
  telemetry    telemetry functionality                                 global      v9.9.9         installed

==
Note: A new version of the Tanzu CLI is available. You are at version: v1.3.0-dev.
To benefit from the latest security and features, please update to a recommended version:
  - v1.5.0-beta.0
  - v1.3.3

Please refer to these instructions for upgrading: https://github.com/vmware-tanzu/tanzu-cli/blob/main/docs/quickstart/install.md.

This message will print at most once per 1 seconds until you update the CLI.
Set TANZU_CLI_RECOMMEND_VERSION_DELAY_DAYS to adjust this period (0 to disable).

Release note

Provide a documentation link when notifying users of the availability of a new CLI version.

Additional information

Special notes for your reviewer