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

readthedocs: git repo does not contain latest tag information #549

Closed
marscher opened this issue Sep 21, 2021 · 5 comments · Fixed by #735
Closed

readthedocs: git repo does not contain latest tag information #549

marscher opened this issue Sep 21, 2021 · 5 comments · Fixed by #735
Labels
CI documentation Improvements or additions to documentation

Comments

@marscher
Copy link
Collaborator

As we derive the version number via setuptools_scm it is crucial to have all the git tags during the build. The version number of the latest build is something "0.1.dev50..." not "0.4.1+devX". I have not found any git related options in the RTD admin tab so far. I think the working copy and the doc build directory are kept to speed up building.
Eventually we need to report this upstream.

@marscher marscher added the documentation Improvements or additions to documentation label Sep 21, 2021
@CagtayFabry
Copy link
Member

i think this might also happen if the fetch depth of the git repo is not sufficient (if you don't fetch tags you cannot determine the latest (and next) version)

look at the changes in the GH actions here I made for this reason
before, the weldx version tag could not be determined correctly (weldx-0.1.dev1+gd3d1289)
with all tag info it gets resolved as it would locally (weldx-0.4.2.dev52+g288a28b)

@marscher
Copy link
Collaborator Author

Yes, this is the cause. So we need to unshallow the git working copy on RTD.

@CagtayFabry
Copy link
Member

we could take a look into how other projects deal with this, should be pretty common I guess

@marscher
Copy link
Collaborator Author

readthedocs/readthedocs.org#5989

@marscher
Copy link
Collaborator Author

marscher commented Apr 5, 2022

The upstream issue has been fixed and is being deployed right now. But I think I should be more patient.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
CI documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants