Skip to content

Build: use same build environment for setup and build #9018

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.

Sign up for GitHub

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

Merged
merged 1 commit into from
Mar 15, 2022
Merged

Build: use same build environment for setup and build #9018

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
109 changes: 54 additions & 55 deletions readthedocs/doc_builder/director.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -97,6 +97,15 @@ def setup_vcs(self):
if commit:
self.data.build["commit"] = commit

def create_build_environment(self):
self.build_environment = self.data.environment_class(
project=self.data.project,
version=self.data.version,
config=self.data.config,
build=self.data.build,
environment=self.get_build_env_vars(),
)

def setup_environment(self):
"""
Create the environment and install required dependencies.
Expand All @@ -105,59 +114,50 @@ def setup_environment(self):
2. create language (e.g. Python) environment
3. install dependencies into the environment
"""
self.build_environment = self.data.environment_class(
project=self.data.project,
# Environment used for building code, usually with Docker
language_environment_cls = Virtualenv
if any(
[
self.data.config.conda is not None,
self.data.config.python_interpreter in ("conda", "mamba"),
]
):
language_environment_cls = Conda

self.language_environment = language_environment_cls(
version=self.data.version,
build_env=self.build_environment,
config=self.data.config,
build=self.data.build,
environment=self.get_build_env_vars(),
)

# Environment used for building code, usually with Docker
with self.build_environment:
language_environment_cls = Virtualenv
if any(
[
self.data.config.conda is not None,
self.data.config.python_interpreter in ("conda", "mamba"),
]
):
language_environment_cls = Conda

self.language_environment = language_environment_cls(
version=self.data.version,
build_env=self.build_environment,
config=self.data.config,
)

# TODO: check if `before_build` and `after_build` are still useful
# (maybe in commercial?)
#
# I didn't find they are used anywhere, we should probably remove them
before_build.send(
sender=self.data.version,
environment=self.build_environment,
)
# TODO: check if `before_build` and `after_build` are still useful
# (maybe in commercial?)
#
# I didn't find they are used anywhere, we should probably remove them
before_build.send(
sender=self.data.version,
environment=self.build_environment,
)

self.pre_system_dependencies()
self.system_dependencies()
self.post_system_dependencies()
self.pre_system_dependencies()
self.system_dependencies()
self.post_system_dependencies()

# Install all ``build.tools`` specified by the user
if self.data.config.using_build_tools:
self.language_environment.install_build_tools()
# Install all ``build.tools`` specified by the user
if self.data.config.using_build_tools:
self.language_environment.install_build_tools()

self.pre_create_environment()
self.create_environment()
self.post_create_environment()
self.pre_create_environment()
self.create_environment()
self.post_create_environment()

self.pre_install()
self.install()
self.post_install()
self.pre_install()
self.install()
self.post_install()

# TODO: remove this and document how to do it on `build.jobs.post_install`
if self.data.project.has_feature(Feature.LIST_PACKAGES_INSTALLED_ENV):
self.language_environment.list_packages_installed()
# TODO: remove this and document how to do it on `build.jobs.post_install`
if self.data.project.has_feature(Feature.LIST_PACKAGES_INSTALLED_ENV):
self.language_environment.list_packages_installed()

def build(self):
"""
Expand All @@ -168,17 +168,16 @@ def build(self):
3. build PDF
4. build ePub
"""
with self.build_environment:
self.data.outcomes = defaultdict(lambda: False)
self.data.outcomes["html"] = self.build_html()
self.data.outcomes["search"] = self.is_type_sphinx()
self.data.outcomes["localmedia"] = self.build_htmlzip()
self.data.outcomes["pdf"] = self.build_pdf()
self.data.outcomes["epub"] = self.build_epub()

after_build.send(
sender=self.data.version,
)
self.data.outcomes = defaultdict(lambda: False)
self.data.outcomes["html"] = self.build_html()
self.data.outcomes["search"] = self.is_type_sphinx()
self.data.outcomes["localmedia"] = self.build_htmlzip()
self.data.outcomes["pdf"] = self.build_pdf()
self.data.outcomes["epub"] = self.build_epub()

after_build.send(
sender=self.data.version,
)

# VCS checkout
def pre_checkout(self):
Expand Down
20 changes: 13 additions & 7 deletions readthedocs/projects/tasks/builds.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -548,13 +548,19 @@ def execute(self):
# objects in the database
self.sync_versions(self.data.build_director.vcs_repository)

# Installing
self.update_build(state=BUILD_STATE_INSTALLING)
self.data.build_director.setup_environment()

# Building
self.update_build(state=BUILD_STATE_BUILDING)
self.data.build_director.build()
# TODO: remove the ``create_build_environment`` hack. Ideally, this should be
# handled inside the ``BuildDirector`` but we can't use ``with
# self.build_environment`` twice because it kills the container on
# ``__exit__``
self.data.build_director.create_build_environment()
with self.data.build_director.build_environment:
# Installing
self.update_build(state=BUILD_STATE_INSTALLING)
self.data.build_director.setup_environment()

# Building
self.update_build(state=BUILD_STATE_BUILDING)
self.data.build_director.build()

@staticmethod
def get_project(project_pk):
Expand Down