-
-
Notifications
You must be signed in to change notification settings - Fork 3.6k
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
Build: READTHEDOCS_GIT_IDENTIFIER
shouldn't be the commit SHA on versions from tags
#11662
Comments
What's the URL of your project? What's the URL of the build where you're noticing this? |
Added. I pasted the URLs into the template wrong I guess |
Where I should check the content of this variable in your documentation? I'm not able to find the the SHA in the page you linked. |
the example line of It should say |
I'm not able to reproduce this issue. I did a try at https://test-builds.readthedocs.io/en/full-feature/environment-variables.html and you can see there that |
I think that variable is never the tag name. It seems that it can only be a branch name and or a commit sha when it's a tag. Using my previous branch, I created a tag named Taking a look at the same page, https://test-builds.readthedocs.io/en/v0.1-full-feature/environment-variables.html, we can see that both environment variables have the same value and it's a commit sha. We use readthedocs.org/readthedocs/builds/models.py Lines 107 to 114 in 173d044
I found that calling
This is a bug and we should fix it. |
READTHEDOCS_GIT_IDENTIFIER
shouldn't be the commit SHA on versions from tags
Details
I'm using
READTHEDOCS_GIT_IDENTIFIER
in my docs to indicate the git tag to check out for a GitHub action. Unfortunately its rendering as the raw SHAExpected Result
READTHEDOCS_GIT_IDENTIFIER
is the name of the tag that was checked outthis is what the docs say it should be
Actual Result
READTHEDOCS_GIT_IDENTIFIER
is the raw commit SHAWorkaround
I guess I can do a
git describe
The text was updated successfully, but these errors were encountered: