Godot Git Describe: seamlessly display release versions based on your Git tags

I just released the first version of a plugin that aims to make showing in-game versions easy if you already use Git tags. Check it out and let me know what you think.

1 Like

Nice. I’ve started creating a bunch of little plugins to easily reuse all my game systems, and this could be helpful to me. Currently I have to change the version in the project settings, the README, and the project name. I hadn’t even thought to tag my releases, but that makes a lot of sense. I just can’t tell from your README how much work this actually saves me.

I’ll try to clarify the readme. How does this sound?

Tags are the most common way to manage version numbers in Git. Tools that make use of these tags simplify development by minimizing the places where you need to manually update your project’s version. Godot Git Describe is one such tool.

With this plugin, you can seamlessly display your Godot project’s version to users without any manual updates. Just keep using tags as usual and this will handle the rest.

If you start using tags for versions, here’s how you could automatically get those versions in each place you mentioned:

Project settings My plugin handles this. The only issue is it might not change the project setting you want it to. For now you can change which one is affected in utilities.gd line 6. You’d need to make the same change in the label script too. I’ll add a setting for this in the future.
README Check out https://shields.io/. You can get a badge that automatically updates based on your tags or releases. See my plugin’s README for an example.
Project name This could be done with small changes to my plugin depending on what you mean. I will add official support for whatever this ends up being.

Great point about shields.io.

For the plugin script I want it to show up in my plugin.cfg file:

[plugin]

name="Dragonforge Sound"
description="A sound autoload singleton to handle all sound for a game."
author="Dragonforge Development"
version="4.4.7"
script="plugin.gd"

In the project itself I want it to show up here:

Appended to the end of the Name field and in the Version field.

1 Like

Sounds good. You can now easily have the plugin set the version field by changing a setting in the latest release. Appending to the project name should also be simple enough for me to add.

The tricky part of changing the plugin config is handling downloads from a repository url (what the Godot asset library typically does). I think I can find a good way to automate it that includes using the export-subst attribute I just learned about.

And thank you for describing your desired use cases! It’s been super helpful for me making this plugin better. :slight_smile:

1 Like

Cool, I’ll try it out.

There’s now a setting for automatically appending to the project name. Let me know if you encounter any issues.