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

Implement submodules key from v2 config #4493

Merged
merged 19 commits into from
Oct 2, 2018

Conversation

stsewd
Copy link
Member

@stsewd stsewd commented Aug 8, 2018

This PR on top of #4456. It should be merged after. New changes are from 2fee268

Closes #4464

@stsewd stsewd added the PR: work in progress Pull request is not ready for full review label Aug 8, 2018
@stsewd
Copy link
Member Author

stsewd commented Aug 9, 2018

The only thing missing is to test v1 with submodules, but I kind of need what I have in #4394

@humitos
Copy link
Member

humitos commented Aug 15, 2018

I will wait until the base PR gets merged to review this.

@agjohnson
Copy link
Contributor

This should be ready for rebase. It's already set to master base.

@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(
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@@ -443,6 +439,22 @@ def run_setup(self, record=True):

return True

def additional_vcs_operations(self):
# TODO: execute with lock
Copy link
Member Author

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)
Copy link
Member Author

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
Copy link
Member Author

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

@agjohnson
Copy link
Contributor

Is this still WIP? Just needs a rebase if not

@stsewd
Copy link
Member Author

stsewd commented Sep 7, 2018

I only have a doubt in #4493 (comment), and then test this for real with the sphinx or mkdocs implementation

@stsewd stsewd self-assigned this Sep 12, 2018
@stsewd
Copy link
Member Author

stsewd commented Sep 28, 2018

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.

@humitos humitos removed the PR: work in progress Pull request is not ready for full review label Oct 1, 2018
Copy link
Contributor

@agjohnson agjohnson left a 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 agjohnson merged commit bfa6bdb into readthedocs:master Oct 2, 2018
@stsewd stsewd deleted the break-submodules-step branch October 2, 2018 16:15
@ax3l
Copy link

ax3l commented Oct 2, 2018

@agjohnson with this PR merged (thx a lot! :) ), is there anything we can add to our .readthedocs.yml already that will exclude recursive git submodule init?

@stsewd
Copy link
Member Author

stsewd commented Oct 2, 2018

@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)

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

Successfully merging this pull request may close these issues.

4 participants