use version from git #264
Closed
use version from git #264
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
* Add a new build flag: -D GIT_VERSION=<string> * gracefully ignored if not inside a git repository or if git returns an error * version format: - 2023.8 when built on a tag - 2023.8-9-g103391f when built later than a tag - 2023.8-9-g103391f-dirty when built on a dirty tree
on linux or on windows ? |
|
Linux. |
|
Thank you for your PR |
|
Hello, |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This patch automates the version string in the firmware by using the most recent available git tag.
python script is automatically called by platformio upon build which appends a GIT_VERSION define to build flags.
version string is built from the output of
git describe --tags --always --dirtycommandSome version examples:
GIT_VERSION is gracefully ignored when the build is not run inside a git repository or if git fails for whatever reason.
For safety I have kept the original code if GIT_VERSION is not defined, but it could make sense to have a generic "unknown" version string or similar.
It has been tested on a linux platform. It should work on windows as well, but it's untested.