Extend install option from config file (v2, schema only) #4732

stsewd · 2018-10-04T21:04:58Z

stsewd · 2018-10-04T21:06:02Z

readthedocs/rtd_tests/fixtures/spec/v2/schema.yml

@@ -53,22 +53,30 @@ python:
  # Default: '3'
  version: enum('2', '2.7', '3', '3.3', '3.4', '3.5', '3.6', required=False)

+  # Give the virtual environment access to the global site-packages dir
+  # Default: false | project config


I'm thinking is never defaulting to a project config on v2.

What do you mean by that? Are we not using the project model config here?

We are, but I think the purpose of v2 is to replace all these configurations from the web admin, that way we can deprecate the admin panel faster.

I like the idea of "do not default to values from admin in v2". Although, if we are deprecating this in a strict way like this, we will need to write a migrate guide or, even better, write a tool that produces the YAML file from the current Admin options.

Otherwise, we will be forcing all of our users that just want one new option from v2 to pass over a more complex and manual process.

I'm doing a chagelog/guide to help the migration from v1 or web #4451. We have discussed about suggesting a v2 config file, but we never created an issue. I'm creating one right now.

stsewd · 2018-10-04T21:07:53Z

readthedocs/rtd_tests/fixtures/spec/v2/schema.yml

+  system_packages: bool(required=False)
+
+  # Installation of packages and requiremens
+  install: list(any(include('python-install-requirements'), include('python-install')), required=False)


We don't install anything by default, are we ok with that? Previously we were installing from requirements.txt if we found one in the project.

hrm, good question. i sort of dislike some of our magic like this, but I'm sure there are a lot of projects working because of this magic right now. With the config file available, new projects have a more reproducible and easy way of adding a requirements file. Maybe we apply a feature flag in a migration here and let old projects continue to magic find requirements.txt?

That's my vote at least.

But this will only affect people using a v2 config file, people using v1 or none, will keep the previous behavior.

yeah, i think you're right, we can change the behavior between the two specs. I'm fine dropping the autofind requirements option for v2

stsewd · 2018-10-04T21:09:28Z

readthedocs/rtd_tests/fixtures/spec/v2/schema.yml

  # The path to the requirements file from the root of the project
-  # Default: null | project config
-  requirements: path(required=False)
+  requirements: path()


No more hacks with requirements: '' (empty string) to avoid installing from requirements (we can keep that behaviour for v1)

oh yeah, v1 could just have the magic find for requirements files, yeah. v2 expects explicit requirements declarations. I'm 👍 on this plan.

stsewd · 2018-10-04T21:10:07Z

readthedocs/rtd_tests/fixtures/spec/v2/schema.yml

-  # Extra requirements sections to install in addition to the package dependencies
+  # Install using python setup.py install or pip
+  # Default: pip
+  method: enum('pip', 'setuptools', required=False)


setuptools instead of setup.py

stsewd · 2018-10-04T21:10:33Z

readthedocs/rtd_tests/tests/test_build_config.py

@@ -74,7 +74,7 @@ def assertInvalidConfig(tmpdir, content, msgs=()):
    with pytest.raises(ValueError) as excinfo:
        validate_schema(file)
    for msg in msgs:
-        msg in str(excinfo.value)
+        assert msg in str(excinfo.value)


Little bug 🐛

stsewd · 2018-10-04T21:12:25Z

I haven't added python.install.[pipenv,package] yet, I want to focus on what we already support first

agjohnson · 2018-10-04T21:24:56Z

good plan! let's note some of the schema changes in the respective issues so we at least have the schema changes planned out.

agjohnson

Looks great! My vote is 👍 on these changes. We can wait for other @rtfd/core to chime in here, but I think we discussed the changes here already in good detail.

humitos

I think this is OK.

I left a comment about the idea of deprecating the settings from Admin if we force our users, that we should consider and maybe open another issue to tackle it.

humitos · 2018-10-10T12:56:15Z

readthedocs/rtd_tests/fixtures/spec/v2/schema.yml

@@ -53,22 +53,30 @@ python:
  # Default: '3'
  version: enum('2', '2.7', '3', '3.3', '3.4', '3.5', '3.6', required=False)

+  # Give the virtual environment access to the global site-packages dir
+  # Default: false | project config


I like the idea of "do not default to values from admin in v2". Although, if we are deprecating this in a strict way like this, we will need to write a migrate guide or, even better, write a tool that produces the YAML file from the current Admin options.

Otherwise, we will be forcing all of our users that just want one new option from v2 to pass over a more complex and manual process.

Extend install option from config file (v2)

970e583

stsewd commented Oct 4, 2018

View reviewed changes

agjohnson approved these changes Oct 4, 2018

View reviewed changes

agjohnson assigned stsewd Oct 5, 2018

stsewd mentioned this pull request Oct 8, 2018

Implement extended install option #4740

Merged

7 tasks

humitos approved these changes Oct 10, 2018

View reviewed changes

stsewd merged commit 3458cde into readthedocs:master Oct 10, 2018

stsewd mentioned this pull request Oct 10, 2018

Suggests a v2 config file from the current options to help transition from v1 or web #4746

Closed

stsewd deleted the extend-install-option branch October 15, 2018 16:58

stsewd mentioned this pull request Oct 22, 2018

Use ignore keyword to ignore the requirements file #4523

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Extend install option from config file (v2, schema only) #4732

Extend install option from config file (v2, schema only) #4732

stsewd commented Oct 4, 2018

stsewd Oct 4, 2018

agjohnson Oct 4, 2018

stsewd Oct 4, 2018

humitos Oct 10, 2018

stsewd Oct 10, 2018

stsewd Oct 4, 2018

agjohnson Oct 4, 2018

stsewd Oct 4, 2018

agjohnson Oct 4, 2018

stsewd Oct 4, 2018

agjohnson Oct 4, 2018

stsewd Oct 4, 2018

stsewd Oct 4, 2018

agjohnson Oct 4, 2018

stsewd commented Oct 4, 2018

agjohnson commented Oct 4, 2018

agjohnson left a comment

humitos left a comment

humitos Oct 10, 2018

Extend install option from config file (v2, schema only) #4732

Extend install option from config file (v2, schema only) #4732

Conversation

stsewd commented Oct 4, 2018

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

stsewd commented Oct 4, 2018

agjohnson commented Oct 4, 2018

agjohnson left a comment

Choose a reason for hiding this comment

humitos left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment