describe

vb describe [VERSION] [OPTIONS]

Description

Provide a description of the given VERSION by showing a non-propagating tag of the youngest tagged ancestor, followed by the number of commits since that, and the short hash of VERSION. Only tags applied to a single check-in are considered.

If no VERSION is provided, describe the currently checked-out version.

If VERSION and the found ancestor refer to the same commit, the last two components are omitted, unless --long is provided. When no fitting tagged ancestor is found, show only the short hash of VERSION.

Options

--digits

Display so many hex digits of the hash (default: the larger of 6 and the hash-digits setting)

-d, --dirty

Show whether there are changes to be committed

--long

Always show all three components

--match GLOB

Consider only non-propagating tags matching GLOB

Examples

• Modify a file and show dirty status

$ vb sys echo "change" >> app.txt && vb describe --dirty
7791c5c4a8-dirty

• Show long format output

$ vb describe --long
bd52c5a292

• Limit the hash length with –digits

$ vb describe --digits 8
bd52c5a2

• Use –match to restrict which tags are considered

$ vb describe --match "v*"
v1.0.0