Skip to content

Commit ec7bed6

Browse files
Post: Use build.os instead of build.image (#233)
* Post: Use `build.os` instead of `build.image` Announcement for readthedocs/readthedocs.org#10589 * Apply suggestions from code review Co-authored-by: Eric Holscher <[email protected]> * Update date --------- Co-authored-by: Eric Holscher <[email protected]>
1 parent cec0938 commit ec7bed6

File tree

1 file changed

+59
-0
lines changed

1 file changed

+59
-0
lines changed

use-build-os-config.rst

Lines changed: 59 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,59 @@
1+
.. post:: August 9, 2023
2+
:tags: builders, deprecation
3+
:author: Manuel
4+
:location: BCN
5+
:category: Changelog
6+
7+
8+
Use ``build.os`` instead of ``build.image`` on your configuration file
9+
======================================================================
10+
11+
We are announcing the deprecation of ``build.image`` config key in favor of ``build.os``.
12+
Read the Docs *will start requiring* a ``build.os`` config key for all projects in order to build documentation successfully.
13+
**We will start failing builds using "build.image" on their config file on October 16, 2023**.
14+
15+
16+
Deprecation timeline
17+
--------------------
18+
19+
We understand this change will affect many of our users,
20+
so we have a timeline to communicate this deprecation to our users effectively.
21+
22+
* **Monday, August 28, 2023**: Do the first brownout (temporarily enforce this deprecation) for 12 hours: 00:01 PST to 11:59 PST (noon)
23+
* **Monday, September 18, 2023**: Do a second brownout (temporarily enforce this deprecation) for 24 hours: 00:01 PST to 23:59 PST (midnight)
24+
* **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)
25+
* **Monday, October 16, 2023**: Fully remove support for building documentation using "build.image" on the configuration file
26+
27+
28+
Migrating to ``build.os``
29+
-------------------------
30+
31+
If you have a project on Read the Docs that is using ``build.image``,
32+
**you will need to migrate to the new config key as soon as possible** to continue building your project.
33+
34+
There are some small differences between ``build.image`` and ``build.os`` that we detail here:
35+
36+
- ``version: 2`` must be used with ``build.os``
37+
- To specify the Python version, you have to use ``build.tools.python``
38+
39+
Below is an example of a valid ``build`` section of your configuration.
40+
Make sure to make these changes before **October 16, 2023**:
41+
42+
43+
.. code:: yaml
44+
45+
version: 2
46+
build:
47+
os: "ubuntu-22.04"
48+
tools:
49+
python: "3.11"
50+
51+
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>`_.
52+
53+
Contact us
54+
----------
55+
56+
`Contact us`_ if you have any questions,
57+
and let us know if you are having trouble using a this new config key for any reason.
58+
59+
.. _Contact us: https://readthedocs.org/support/

0 commit comments

Comments
 (0)