Skip to content

Commit

Permalink
Post: Use build.os instead of build.image
Browse files Browse the repository at this point in the history
  • Loading branch information
humitos committed Aug 1, 2023
1 parent a05e582 commit 3785b97
Showing 1 changed file with 57 additions and 0 deletions.
57 changes: 57 additions & 0 deletions use-build-os-config.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,57 @@
.. post:: August 7, 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 shown how the ``build`` config key section would be after applying these changes.
Make sure to make these changes before October 16, 2023.

.. code:: yaml
version: 2
build:
os: "ubuntu-22.04"
tools:
python: "3.11"
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/

0 comments on commit 3785b97

Please sign in to comment.