-
Notifications
You must be signed in to change notification settings - Fork 47
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
Post: Use build.os
instead of build.image
#233
Merged
Merged
Changes from all commits
Commits
Show all changes
4 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,59 @@ | ||
.. post:: August 9, 2023 | ||
:tags: builders, deprecation | ||
:author: Manuel | ||
:location: BCN | ||
:category: Changelog | ||
|
||
|
||
Use ``build.os`` instead of ``build.image`` on your configuration file | ||
====================================================================== | ||
|
||
We are announcing the deprecation of ``build.image`` config key in favor of ``build.os``. | ||
Read the Docs *will start requiring* a ``build.os`` config key for all projects in order to build documentation successfully. | ||
**We will start failing builds using "build.image" on their config file on October 16, 2023**. | ||
|
||
|
||
Deprecation timeline | ||
-------------------- | ||
|
||
We understand this change will affect many of our users, | ||
so we have a timeline to communicate this deprecation to our users effectively. | ||
|
||
* **Monday, August 28, 2023**: Do the first brownout (temporarily enforce this deprecation) for 12 hours: 00:01 PST to 11:59 PST (noon) | ||
* **Monday, September 18, 2023**: Do a second brownout (temporarily enforce this deprecation) for 24 hours: 00:01 PST to 23:59 PST (midnight) | ||
* **Monday, October 2, 2023**: Do a third and final brownout (temporarily enforce this deprecation) for 48 hours: 00:01 PST to October 3, 2023 23:59 PST (midnight) | ||
* **Monday, October 16, 2023**: Fully remove support for building documentation using "build.image" on the configuration file | ||
|
||
|
||
Migrating to ``build.os`` | ||
------------------------- | ||
|
||
If you have a project on Read the Docs that is using ``build.image``, | ||
**you will need to migrate to the new config key as soon as possible** to continue building your project. | ||
|
||
There are some small differences between ``build.image`` and ``build.os`` that we detail here: | ||
|
||
- ``version: 2`` must be used with ``build.os`` | ||
- To specify the Python version, you have to use ``build.tools.python`` | ||
|
||
Below is an example of a valid ``build`` section of your configuration. | ||
Make sure to make these changes before **October 16, 2023**: | ||
|
||
|
||
.. code:: yaml | ||
|
||
version: 2 | ||
build: | ||
os: "ubuntu-22.04" | ||
tools: | ||
python: "3.11" | ||
|
||
humitos marked this conversation as resolved.
Show resolved
Hide resolved
|
||
You can read about the ``build.os`` key, including all possible values, in our `"build.os" documentation <https://docs.readthedocs.io/en/stable/config-file/v2.html#build-os>`_. | ||
|
||
Contact us | ||
---------- | ||
|
||
`Contact us`_ if you have any questions, | ||
and let us know if you are having trouble using a this new config key for any reason. | ||
|
||
.. _Contact us: https://readthedocs.org/support/ |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Is it possible to sync up any of these brownouts with our existing brownouts for the config file deprecation? I feel like having a brownout almost every month for the next couple months is a lot. It would be good if we could just codify the brownout (eg.
if date(2023, 08, 28) < datetime.now() date(2023, 08, 29)
in the code vs. a feature flag)There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Cool. I've done this in 458913eab209217a17791b721e2eb5dfe4b33f1a