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

Deprecation: remove code for config file v1 and default config file #10367

Merged
merged 26 commits into from
Oct 23, 2023

Conversation

humitos
Copy link
Member

@humitos humitos commented May 30, 2023

This is a continuation of the work done for

In that work we added notifications, warning messages and finally a feature flag to start failing the builds without a configuration file or using v1.

This commit removes all the code for config file v1 and building without a configuration file. Due to that, it also removes the code that allows users to use the older Docker images (testing, latest, stable)

This work can be merged once we enable the feature flag to fail the builds for all the projects and we are happy with the results.

Related:

This is a continuation of the work done for

* #10351
* #10342
* #10348
* #10355

In that work we added notifications, warning messages and finally a feature flag
to start failing the builds without a configuration file or using v1.

This commit removes all the code for config file v1 and building without a
configuration file. Due to that, it also removes the code that allows users to
use the older Docker images (testing, latest, stable)

This work can be merged once we enable the feature flag to fail the builds for
all the projects and we are happy with the results.
@humitos humitos added the Status: blocked Issue is blocked on another issue label May 30, 2023
@humitos
Copy link
Member Author

humitos commented May 30, 2023

This commit removes all the code for config file v1 and building without a configuration file. Due to that, it also removes the code that allows users to use the older Docker images (testing, latest, stable)

I created a Metabase question to know how many projects are still manually specifying build.image on their config file: https://ethicalads.metabaseapp.com/question/405-projects-specifying-build-image-config-file?days=90. In the last 90 days, we currently have ~1.1k projects using build.image on their config file

@humitos
Copy link
Member Author

humitos commented Aug 31, 2023

Update this PR to disable the "Advanced settings" from Admin page: readthedocs/ext-theme#159 (comment)

@humitos
Copy link
Member Author

humitos commented Sep 4, 2023

I updated this PR with the latest changes from origin/main

This commit removes all the code for config file v1 and building without a configuration file. Due to that, it also removes the code that allows users to use the older Docker images (testing, latest, stable)

We are deprecating this on October 16th (see #10587), so we may want to merge this after that day or adapt this PR to keep build.image for now.

@ericholscher
Copy link
Member

@humitos I saw merging this in the release tasks, but seems it's not ready?

@humitos
Copy link
Member Author

humitos commented Sep 19, 2023

He, yeah. I added this PR into this release a long time ago expecting to be ready by this time 😅

I'll update it in the next few days and ask for a review.

@humitos
Copy link
Member Author

humitos commented Sep 22, 2023

Due to #10367 (comment), I think we can merge this PR after October 16th and reduce the workload in our side.

@humitos humitos self-assigned this Sep 22, 2023
@humitos humitos marked this pull request as ready for review October 17, 2023 16:21
@humitos humitos requested review from a team as code owners October 17, 2023 16:21
@humitos humitos removed the Status: blocked Issue is blocked on another issue label Oct 17, 2023
@humitos
Copy link
Member Author

humitos commented Oct 17, 2023

This PR is ready to review and merge. After that, we can also merge https://github.com/readthedocs/readthedocs-ops/pull/1383 to remove old Docker images from AMI and builders.

@humitos
Copy link
Member Author

humitos commented Oct 19, 2023

@stsewd @ericholscher this PR removes everything related to config file v1 and default config file. I'd appreciate a review on it so we can move forward with this deprecation and finally remove this code from our repository.

Note that there is no need to do an extensive review on it since it's pretty big and, in theory, there is no changes in logic or similar. All the code removed from this PR should not be used by anybody at this point since we already passed the final removal date.

Also, since it changes 5k lines, I'd appreciate if we can merge it sooner and make the needed/small changes in another PR if required to avoid having to deal with merge conflicts again.

docs/user/config-file/v1.rst Outdated Show resolved Hide resolved
@humitos humitos enabled auto-merge (squash) October 19, 2023 15:45
readthedocs/settings/base.py Show resolved Hide resolved
readthedocs/projects/models.py Show resolved Hide resolved
@humitos humitos merged commit dcccac0 into main Oct 23, 2023
4 checks passed
@humitos humitos deleted the humitos/deprecation-no-config-file-and-v1 branch October 23, 2023 10:33
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Archived in project
Development

Successfully merging this pull request may close these issues.

3 participants