-
-
Notifications
You must be signed in to change notification settings - Fork 3.6k
Add temporary method for skipping submodule checkout #3821
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
Conversation
cd5a646
to
d74f0a1
Compare
d74f0a1
to
239b07c
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks good to me. Doesn't this require a migration?
This feels like something that we should be exposing to the users as an option, no? Having it be a "backend only feature" makes it so that only a support email can fix it, instead of just allowing users to turn it off. I'm not sure I really like this as a longer term pattern.
I realize this is just a quick fix to unbreak a client, but it still feels like something we should be adding to the YAML configs.
Yup, I think the delineation is features are short lived, there shouldn't be a UI for this. I agree the ideal solution is definitely YAML config, but there's no movement on readthedocs/readthedocs-build#30 just yet. No migration is needed for adding a Feature, though I think that was how I originally wrote the code. The admin form just does a lookup for field choices on instantiation. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This looks good.
Echoing Eric, I'm fine with this as a temporary solution as the real solution is the YAML file.
I'm not sure if we ever remove old features after they were created, but it doesn't seem to interferes with the rest of the codebase and it doesn't seem to be a huge amount of code to remove anyway.
For some reason the latest commit didn't trigger tests. Can you check that? |
Yeah, i'm not sure. I tried to manually trigger them and it didn't work. 😕 Edit: changed base to master, tests have been fired off |
return [code, out, err] | ||
|
||
def clone(self): | ||
code, _, _ = self.run( | ||
'git', 'clone', '--recursive', self.repo_url, '.') | ||
code, _, _ = self.run('git', 'clone', '--recursive', self.repo_url, '.') |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Should this also be separated? I mean deleting the --recursive
option https://git-scm.com/docs/git-clone/2.8.0#git-clone---recursive and make the submodules init/update on other step.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Also that option was dropped and now only --recurse-submodules
is used on the latest git version https://git-scm.com/docs/git-clone#git-clone---recurse-submodulesltpathspec
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think @stsewd is right here. We should remove the --recursive
option. Otherwise, we will be trying to clone the submodules in the initial clone.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Oh hrm, yeah. Good point!
This adds a project feature that allows for a project to specify that they would like to skip submodule installation. Currently we are forcing all submodules to be checked out, so this fails on private submodules. Refs readthedocs/readthedocs-build#30
54edcf0
to
5a8a24b
Compare
I just added the workaround for git clone step and rebased |
This adds a project feature that allows for a project to specify that they would
like to skip submodule installation. Currently we are forcing all submodules to
be checked out, so this fails on private submodules.
Refs readthedocs/readthedocs-build#30
Based on #3822 for autolint cleanup