https://blog.readthedocs.com 2023-07-08T10:50:30.126215+00:00 ABlog https://blog.readthedocs.com/pull-request-builder-general-availability/ 2021-01-27T00:00:00+00:00 Eric Holscher <section id="pull-request-builders-available-for-all-users"> <p>We’re excited to announce that <a class="reference external" href="https://docs.readthedocs.io/en/latest/guides/autobuild-docs-for-pull-requests.html">Pull Request building</a> is now available for all Read the Docs users. We have been working on this feature for over a year, and having it available for all our users is a major milestone.</p> <p>This feature allows users to confirm documentation builds correctly for all of their commits, not just ones merged into branches that are activated on Read the Docs. This moves documentation into your continuous integration pipeline, and improves the workflow for everyone working on documentation.</p> <figure class="align-default" id="id1"> <img alt="GitHub Build Status Reporting for Pull Requests." src="../../../_images/github-build-status-reporting.gif" style="width: 70%;" /> <figcaption> <p><span class="caption-text">GitHub Build Status Reporting for Pull Requests</span></p> </figcaption> </figure> <p>You can read more about this new feature in our <a class="reference internal" href="../../../building-docs-for-pull-requests/"><span class="doc">previous blog post announcing it</span></a> and in our <a class="reference external" href="https://docs.readthedocs.io/page/guides/autobuild-docs-for-pull-requests.html">documentation for the feature</a>.</p> <section id="serving-docs-for-every-branch"> <h2>Serving docs for every branch</h2> <p>Along with building and validating each branch on your repository, <strong>we also host a rendered version of the documentation.</strong> This allows you to see exactly how the docs will look when they are deployed.</p> <p>Building the documentation on Read the Docs during the development process also helps test integration with Read the Docs. The entire build process is run for each commit, so this will ensure that builds work as expected when you’re ready to merge into production.</p> <p>These previews will stay live for 90 days from the time you merge or close the Pull Request, allowing you to finish any outstanding work on the task.</p> </section> <section id="limitations"> <h2>Limitations</h2> <p>Due to the increased demand for build resources, the Pull Request builders have the following limitations:</p> <ul class="simple"> <li><p>Read the Docs search is not enabled on these versions</p></li> <li><p>Only HTML versions of the documentation are built (not PDF, ePub, etc.)</p></li> <li><p>Documentation builds are concurrency limited. Read the Docs for Business concurrency varies based on your plan, and Read the Docs Community are limited to 2 concurrent builds.</p></li> </ul> <p>We are working to address these limitations over time, but given the increase in scale with these builds it will take some time.</p> </section> <section id="give-us-feedback"> <h2>Give us feedback</h2> <p>We always love to hear from our users about the product. If you have feedback on this feature of any others, you can always reach us at <a class="reference external" href="mailto:hello&#37;&#52;&#48;readthedocs&#46;org">hello<span>&#64;</span>readthedocs<span>&#46;</span>org</a>.</p> </section> </section>

We’re excited to announce that Pull Request building is now available for all Read the Docs users. We have been working on this feature for over a year, and having it available for all our users is a major milestone.This feature allows users to confirm documentation builds correctly for all of their commits, not just ones merged into branches that are activated on Read the Docs. This moves documentation into your continuous integration pipeline, and improves the workflow for everyone working on documentation.

2021-01-27T00:00:00+00:00