pingcap / pingcap/tiup

version information message is confusing

Open
#831 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

category/usability status/TODO
Dominant language
Go
Stars
466
Forks
338
Avg merge
3d 7h
Merged PRs (30d)
8

Description

I run tiup playground, there is some boilerplate on the console, and

Use the latest stable version: v4.0.7

    Specify version manually:   tiup playground <version>
    The stable version:         tiup playground v4.0.0
    The nightly version:        tiup playground nightly

This is in yellow, which suggests its a warning, but its not clear if something is wrong or not (I guess this is just information). It is not clear to me what this is telling me or why. I think the whole message could probably just be removed. If it is kept I recommend changing the colour and re-wording:

INFO currently using latest stable version: v4.0.7.
INFO to specify a version, use `tiup playground <version>`
INFO `<version>` can be a version number, e.g., `v4.0.0`, or a channel name: `stable` or `nightly`

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by running tiup playground and tracing the source that emits the version information message. Compare the current yellow output with the proposed wording and determine whether the message should be removed or revised; done means the resulting console output clearly presents informational status rather than a warning.

Written by the indexing model from the issue text.

Assessment

Tech stack
go
Domain
cli
Issue type
Bug
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.