-
-
Notifications
You must be signed in to change notification settings - Fork 3.6k
Implement submodules key from v2 config #4493
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
The only thing missing is to test v1 with submodules, but I kind of need what I have in #4394 |
I will wait until the base PR gets merged to review this. |
This should be ready for rebase. It's already set to master base. |
7b3fdf9
to
edf212c
Compare
@patch('readthedocs.doc_builder.backends.sphinx.BaseSphinx.move') | ||
@patch('readthedocs.doc_builder.backends.sphinx.BaseSphinx.append_conf') | ||
@patch('readthedocs.doc_builder.backends.sphinx.BaseSphinx.run') | ||
def test_sphinx_fail_on_warning( |
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.
Not sure how this landed here... Anyway this test was added in https://github.com/rtfd/readthedocs.org/pull/4456/files#diff-5a2cc4147895068b33fe5bf89e4e6e08R685
1a448bc
to
43c0b38
Compare
readthedocs/projects/tasks.py
Outdated
@@ -443,6 +439,22 @@ def run_setup(self, record=True): | |||
|
|||
return True | |||
|
|||
def additional_vcs_operations(self): | |||
# TODO: execute with lock |
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 this step should be done with the context management, the one that creates a lock
return False | ||
|
||
# Keep compatibility with previous projects | ||
code, out, _ = self.run('git', 'submodule', 'status', record=False) |
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.
We were running this code to check for submodules previously, so we need to keep the same behavior here
@@ -43,6 +43,7 @@ class BaseVCS(object): | |||
|
|||
supports_tags = False # Whether this VCS supports tags or not. | |||
supports_branches = False # Whether this VCS supports branches or not. | |||
supports_submodules = False |
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 way we can say what vcs needs to do an extra step
Is this still WIP? Just needs a rebase if not |
I only have a doubt in #4493 (comment), and then test this for real with the sphinx or mkdocs implementation |
43c0b38
to
8f47fee
Compare
8f47fee
to
770280f
Compare
I figure out that we don't need the lock in the submodules operation, I guess the lock is there so we don't end with several builds of the same version. This PR is tested and ready for review. |
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 great! 👍
I can't think of any other changes required here, so i think this is just safe to merge.
@agjohnson with this PR merged (thx a lot! :) ), is there anything we can add to our |
@ax3l this isn't deployed yet, and it's part of the v2 of our configuration file, I'm trying to get some users to a beta soon, please let your project here #1621 (comment) |
This PR on top of #4456. It should be merged after. New changes are from 2fee268
Closes #4464