Godot Git Describe

Do you use tags to label your project's releases? Do you want to display those labels in your project without manually setting a separate value?

You've come to the right place.

Features

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

Installation

See the Godot documentation for installing plugins:

https://docs.godotengine.org/en/stable/tutorials/plugins/editor/installing_plugins.html

Usage

1. Label a release using a tag
2. Add a GitDescribeLabel to a scene or adjust project settings as desired
3. Run or export the project

Settings

GGD's project settings are found under the setting path addons/git_describe.

Name	Description	Default Value
Append Describe to Project Name	If true, GGD appends the describe string to your project's name on run or export.	false
Describe Setting Path	Path of the setting that GGD sets to the describe string on run or export.	"application/config/git_describe"
Command Options[1]	Options that GGD passes to the describe command. See the Git docs for available options.	"--always"
User Extensions Dir[1]	Directory that GGD searches for user-made extensions to load on startup. Allows presence of unrelated files.	""

[1]: Advanced setting; only shown when the "Advanced Settings" option is enabled.

Extensions

Extensions add new features for GGD to use when you run or export your project. GGD uses extensions internally, which are a helpful reference when making your own.

To create and enable an extension:

1. Create a script that extends GitDescribeExtension
2. Override _init with any setup your extension needs
3. Override _set_describe to make changes with the describe string
4. Override _erase_describe to undo the changes made by _set_describe
5. Set the "User Extensions Dir" project setting to the directory that contains your extension
6. Reload the project