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

Pipfile support (schema) #4782

Merged
merged 5 commits into from Nov 13, 2018
Merged

Pipfile support (schema) #4782

merged 5 commits into from Nov 13, 2018

Conversation

@stsewd
Copy link
Member

@stsewd stsewd commented Oct 18, 2018

Ref #3181

@stsewd stsewd requested a review from Oct 18, 2018
Copy link
Member

@humitos humitos left a comment

I'm blocking this one because the YAML is important and I want to be sure that I'm understanding the changes proposed here before I approve it.

In particular, the options --skip-lock and --ignore-pipfile are kind of confusing after reading the documentation. Using them together doesn't make too much sense and seems that pipenv should fail.

assertValidConfig(tmpdir, content.format(value=value))


@pytest.mark.parametrize('value', [True, False])
Copy link
Member

@humitos humitos Oct 22, 2018

True and False shouldn't be true and false since it's a YAML file?

Other tests use true and false, which I think it's correct.

readthedocs/rtd_tests/tests/test_build_config.py Outdated Show resolved Hide resolved
@@ -77,6 +77,22 @@ python-install:
# Default: []
extra_requirements: list(str(), required=False)

python-install-pipfile:
# The path to the project to be installed
Copy link
Member

@humitos humitos Oct 22, 2018

I think this should be,

The path to the directory that contains the Pipfile to use

since the project is not going to be installed, but all the dependencies on the Pipfile.

@codecov
Copy link

@codecov codecov bot commented Oct 23, 2018

Codecov Report

Merging #4782 into master will increase coverage by 0.1%.
The diff coverage is n/a.

@@            Coverage Diff            @@
##           master    #4782     +/-   ##
=========================================
+ Coverage   76.12%   76.22%   +0.1%     
=========================================
  Files         158      158             
  Lines       10007    10025     +18     
  Branches     1261     1264      +3     
=========================================
+ Hits         7618     7642     +24     
+ Misses       2044     2039      -5     
+ Partials      345      344      -1
Impacted Files Coverage Δ
readthedocs/config/config.py 98.03% <0%> (ø) ⬆️
readthedocs/projects/forms.py 79.38% <0%> (+0.46%) ⬆️
readthedocs/projects/models.py 84.04% <0%> (+1.27%) ⬆️
readthedocs/builds/forms.py 87.87% <0%> (+5.27%) ⬆️

@stsewd
Copy link
Member Author

@stsewd stsewd commented Oct 24, 2018

@agjohnson @humitos this is ready for re-review, I have changed (inverted) the defaults as #4782 (comment)

Copy link
Contributor

@agjohnson agjohnson left a comment

Awesome, I think the schema matches how we want to use pipfile by default. I'm excited to get this implemented!

I think this satisfies the all the feedback, so we can unblock this. If @humitos has no other feedback tihs is ready for merge!

Copy link
Member

@humitos humitos left a comment

Everything looks 👍

@@ -330,17 +330,38 @@ def test_python_install_extra_requirements_empty(tmpdir, value):
assertValidConfig(tmpdir, content.format(value=value))


def test_python_install_pipfile(tmpdir):
@pytest.mark.parametrize('pipfile', ['another_docs/', '.', 'project/'])
Copy link
Member

@humitos humitos Nov 13, 2018

💯

@stsewd stsewd merged commit 062b010 into readthedocs:master Nov 13, 2018
3 checks passed
@stsewd stsewd deleted the pipfile-schema branch Nov 13, 2018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Linked issues

Successfully merging this pull request may close these issues.

None yet

3 participants