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.

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

Build: remove "beta" from build.commands #11411

Merged
merged 4 commits into from
Jun 17, 2024
Merged

Build: remove "beta" from build.commands #11411

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
57a9745
Build: remove "beta" from `build.commands`
humitos Jun 13, 2024
1b48532
Apply suggestions from code review
humitos Jun 17, 2024
b2f139e
Merge branch 'main' into humitos/no-beta-build-commands
humitos Jun 17, 2024
a48364e
Apply suggestions from code review
humitos Jun 17, 2024
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
9 changes: 5 additions & 4 deletions docs/user/build-customization.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -414,11 +414,12 @@ Take a look at the following example:
Override the build process
--------------------------

.. warning::
.. note::

This feature is in *beta* and could change without warning.
We are currently testing :ref:`the new addons integrations we are building <rtd-blog:addons-flyout-menu-beta>`
on projects using ``build.commands`` configuration key.
We are using :ref:`our new addons integration <rtd-blog:addons-flyout-menu-beta>`
on projects using ``build.commands``.
This will become the default soon,
but has some slight differences from our previous flyout.

If your project requires full control of the build process,
and :ref:`extending the build process <build-customization:extend the build process>` is not enough,
Expand Down
10 changes: 5 additions & 5 deletions docs/user/config-file/v2.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -468,12 +468,12 @@ When ``build.commands`` is used, none of the :term:`pre-defined build jobs` will
This allows you to run custom commands and control the build process completely.
The ``$READTHEDOCS_OUTPUT/html`` directory will be uploaded and hosted by Read the Docs.

.. warning::
.. note::

This feature is in a *beta phase* and could suffer incompatible changes or even removed completely in the near feature.
We are currently testing `the new addons integrations we are building <rtd-blog:addons-flyout-menu-beta>`_
on projects using ``build.commands`` configuration key.
Use it under your own responsibility.
We are using :ref:`our new addons integration <rtd-blog:addons-flyout-menu-beta>`
on projects using ``build.commands``.
This will become the default soon,
but has some slight differences from our previous flyout.

.. code-block:: yaml
Expand Down
4 changes: 0 additions & 4 deletions readthedocs/doc_builder/director.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -418,10 +418,6 @@ def check_old_output_directory(self):
def run_build_commands(self):
"""Runs each build command in the build environment."""

self.attach_notification(
message_id=BuildUserError.BUILD_COMMANDS_IN_BETA,
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Shouldn't this also be removed? I guess existing notifications use this message, but we could also just delete those.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yeah, existing notification use this message. We can decide what to do with them --but I think it's fine to keep them for now.

)

reshim_commands = (
{"pip", "install"},
{"conda", "create"},
Expand Down