Version: don't use default_branch when getting the commit name #10885
Conversation
This file contains hidden or 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
The name of the branch used is already in the version itself, we don't need to depend on the project. This doesn't work on the builders, because we use the APIProject object, which doesn't have access to the DB nor has the remote_repository relationship in it. https://github.com/readthedocs/readthedocs.org/blob/fe7e976dbf989f1eee04368df3427086edfb89c9/readthedocs/projects/models.py#L1262-L1263
ericholscher
approved these changes
Nov 2, 2023
|
This isn't going to work, as we have an special case for latest's identifier being none. |
Every time we touch this code we break some particular use case. I know that you have been digging pretty deep into this lately, maybe it's worth to dump your knowledge into a page that documents the logic in our code for all the possible workflows. Maybe with that document, we can be all in the same page and avoid future breaking changes. Just an idea. |
|
#10892 has a description about the special cases of the versions that I found. Having a single document describing the whole build process could be helpful 👍 |
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.
The name of the branch used is already in the version itself, we don't need to depend on the project's
get_default_branch.This doesn't work on the builders, because we use
the APIProject object, which doesn't have access to the DB nor has the remote_repository relationship in it.
readthedocs.org/readthedocs/projects/models.py
Lines 1262 to 1263 in fe7e976
In cases where users have
project.default_branh = None, this was returning master instead of the GitHub's default.