Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Set version and release in build workflow #3140

Merged
merged 1 commit into from
Jul 10, 2020

Conversation

dunkmann00
Copy link

This aims to fix #3134.

It sets the version and release values to the output of git describe --dirty --tags when sphinx-build is run in the build workflow. This overrides the value that is set in conf.py of 0.0.0.

I've tested building the docs using the -D flag and manually setting the version and release values and that seems to work just fine. But I do not know if this approach of using the output from git describe --dirty --tags will give the value needed. Either way I figured this is hopefully a good start!

@tannewt tannewt self-requested a review July 10, 2020 18:13
Copy link
Member

@tannewt tannewt left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you! Will merge and we can double check it works.

@tannewt tannewt merged commit 37e77b2 into adafruit:main Jul 10, 2020
@dunkmann00 dunkmann00 deleted the docs-version-conf branch July 13, 2020 19:24
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Docs title tag always shows 0.0.0
2 participants