Documentation

What is Git describe?

Git's describe command is a convenient way to get a human-readable label for your repository's state.

Examples

# If the latest commit is tagged, then you simply get that tag. Perfect for version numbers.
$ git describe
1.0.0

# Made a commit since the last tag? Output includes the number of commits since that tag plus the latest commit hash.
$ git describe
1.0.0-1-abcd123

# No tags? You can fall back to an abbreviated commit hash instead.
$ git describe --always
abcd123

# Have uncommitted changes? That can be accounted for.
$ git describe --dirty
1.0.0-dirty

$ git describe --dirty=-your-text-here
1.0.0-your-text-here

Why use Git describe instead of a commit hash?

1. It's more readable when tags are involved.
2. It's more informative (e.g., you can easily show when there are uncommitted changes).
3. It still includes the abbreviated hash when relevant.

Features

• Adds your Git repository's description to your project on run or export.
• Reverts changes when you stop your project or an export is finished.
• Batteries included: comes with nodes and settings that cover common use cases.