Skip to content

Deprecation: codify browndates for "no config file deprecation" #10612

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 12 commits into from
Aug 9, 2023
Merged

Deprecation: codify browndates for "no config file deprecation" #10612

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
12 commits
Select commit Hold shift + click to select a range
8227721
Deprecation: notification and feature flag for `build.image` config
humitos Aug 1, 2023
450b97a
Merge branch 'main' into humitos/deprecate-build-image-config-key
humitos Aug 3, 2023
b1810c3
Deprecation: notification and feature flag for `build.image` config
humitos Aug 1, 2023
ac5891a
Merge branch 'humitos/deprecate-build-image-config-key' of github.com…
humitos Aug 3, 2023
0883154
Review and update logic
humitos Aug 3, 2023
f6399df
Start emailing people with projects building from 3 years ago
humitos Aug 3, 2023
41150cc
Apply suggestions from code review
humitos Aug 8, 2023
75921e4
Add HTML version of the email
humitos Aug 8, 2023
458913e
Codify brownout dates and remove the feature flag
humitos Aug 8, 2023
4584cdf
Use UTC datetimes to compare
humitos Aug 8, 2023
f286859
Deprecation: codify browndates for "no config file deprecation"
humitos Aug 8, 2023
5a108d3
Merge branch 'main' of github.com:readthedocs/readthedocs.org into hu…
humitos Aug 9, 2023
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
19 changes: 13 additions & 6 deletions readthedocs/doc_builder/director.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,6 @@
from readthedocs.doc_builder.python_environments import Conda, Virtualenv
from readthedocs.projects.constants import BUILD_COMMANDS_OUTPUT_PATH_HTML
from readthedocs.projects.exceptions import RepositoryError
from readthedocs.projects.models import Feature
from readthedocs.projects.signals import after_build, before_build, before_vcs
from readthedocs.storage import build_tools_storage

Expand Down Expand Up @@ -250,16 +249,24 @@ def checkout(self):
self.data.build["config"] = self.data.config.as_dict()
self.data.build["readthedocs_yaml_path"] = custom_config_file

now = timezone.now()

# fmt: off
# These browndates matches https://blog.readthedocs.com/use-build-os-config/
browndates = any([
timezone.datetime(2023, 7, 14, 0, 0, 0, tzinfo=timezone.utc) < now < timezone.datetime(2023, 7, 14, 12, 0, 0, tzinfo=timezone.utc), # First, 12hs
timezone.datetime(2023, 8, 14, 0, 0, 0, tzinfo=timezone.utc) < now < timezone.datetime(2023, 8, 15, 0, 0, 0, tzinfo=timezone.utc), # Second, 24hs
timezone.datetime(2023, 9, 4, 0, 0, 0, tzinfo=timezone.utc) < now < timezone.datetime(2023, 9, 6, 0, 0, 0, tzinfo=timezone.utc), # Third, 24hs
timezone.datetime(2023, 9, 25, 0, 0, 0, tzinfo=timezone.utc) < now, # Fully removal
])
# fmt: on

# Raise a build error if the project is not using a config file or using v1
if self.data.project.has_feature(
Feature.NO_CONFIG_FILE_DEPRECATED
) and self.data.config.version not in ("2", 2):
if browndates and self.data.config.version not in ("2", 2):
raise BuildUserError(BuildUserError.NO_CONFIG_FILE_DEPRECATED)

# Raise a build error if the project is using "build.image" on their config file

now = timezone.now()

# fmt: off
# These browndates matches https://blog.readthedocs.com/use-build-os-config/
browndates = any([
Expand Down
5 changes: 0 additions & 5 deletions readthedocs/projects/models.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1949,7 +1949,6 @@ def add_features(sender, **kwargs):
# Build related features
GIT_CLONE_FETCH_CHECKOUT_PATTERN = "git_clone_fetch_checkout_pattern"
HOSTING_INTEGRATIONS = "hosting_integrations"
NO_CONFIG_FILE_DEPRECATED = "no_config_file"
SCALE_IN_PROTECTION = "scale_in_prtection"

FEATURES = (
Expand Down Expand Up @@ -2089,10 +2088,6 @@ def add_features(sender, **kwargs):
"Proxito: Inject 'readthedocs-addons.js' as <script> HTML tag in responses."
),
),
(
NO_CONFIG_FILE_DEPRECATED,
_("Build: Building without a configuration file is deprecated."),
),
(
SCALE_IN_PROTECTION,
_("Build: Set scale-in protection before/after building."),
Expand Down