Set version and release in build workflow #3140
Merged
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 aims to fix #3134.
It sets the
version
andrelease
values to the output ofgit describe --dirty --tags
whensphinx-build
is run in the build workflow. This overrides the value that is set inconf.py
of 0.0.0.I've tested building the docs using the
-D
flag and manually setting theversion
andrelease
values and that seems to work just fine. But I do not know if this approach of using the output fromgit describe --dirty --tags
will give the value needed. Either way I figured this is hopefully a good start!