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

Better UX when git checkout to a not existing branch/tag #4259

Closed
stsewd opened this issue Jun 18, 2018 · 4 comments · Fixed by #4901
Closed

Better UX when git checkout to a not existing branch/tag #4259

stsewd opened this issue Jun 18, 2018 · 4 comments · Fixed by #4901
Labels
Needed: design decision A core team decision is required

Comments

@stsewd
Copy link
Member

stsewd commented Jun 18, 2018

Sometimes we can end in a case where the user deletes a version in their repo and want to build that version in rtd. When this happens, the user needs to build a different available version.

Because of the order of the build process, a wipe isn't enough to solve this

  • RTD will clone or update the repo as a first step
  • Then, rtd will fetch the new versions (and deletions)
  • RTD will checkout to the version that is going to build
    • RTD will fail here because executes git checkout latest
    • latest doesn't exist on the repo at the time (we updated the repo!)
  • RTD will sync the versions with the data from the repo
    • This step never happens it the previous fails

This currently affects branches only and should affect tags after #4258 is solved

Raised in #3913 (comment)

@stsewd stsewd changed the title Better UX when git checkout to an not existing branch/tag Better UX when git checkout to a not existing branch/tag Jun 18, 2018
@stsewd stsewd added the Needed: design decision A core team decision is required label Jun 18, 2018
@stsewd
Copy link
Member Author

stsewd commented Jun 18, 2018

A solution can be: change the build process order

  • clone or update the repo as a first step
  • fetch the new versions (and deletions)
  • sync the versions with the data from the repo
  • checkout to the version that is going to build

But I'm not sure about the consequences of this change

https://github.com/rtfd/readthedocs.org/blob/9a4c45932cf6f1cf4f878e06e27d281f2cf24736/readthedocs/projects/tasks.py#L145-L147

@humitos
Copy link
Member

humitos commented Nov 15, 2018

I suppose that this issue will be solved by #4876, right?

@stsewd
Copy link
Member Author

stsewd commented Nov 15, 2018

Yup, I forgot to linked it

@stsewd
Copy link
Member Author

stsewd commented Nov 15, 2018

Actually no, this one will fix this #4901

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Needed: design decision A core team decision is required
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants