https://blog.readthedocs.comRead the Docs Blog - Posts tagged automation-rules2023-07-08T10:50:30.041393+00:00ABloghttps://blog.readthedocs.com/automation-rules/Automation Rules2020-05-04T00:00:00+00:00Santos Gallegos<section id="automation-rules">
<p>A time ago we introduced a new feature to help users to automate some tasks on Read the Docs.
<a class="reference external" href="https://docs.readthedocs.io/en/stable/automation-rules.html" title="(in Read the Docs user documentation v9.15.0)"><span class="xref std std-doc">Automation rules</span></a>.</p>
<p>If you manage a project with several versions,
you may have noticed that Read the Docs doesn’t always activate your new versions <a class="footnote-reference brackets" href="#id2" id="id1">1</a>.
If you require to do any action over a new version,
you’ll need to log in your Read the Docs account and manually do so.</p>
<p>With automation rules,
you can choose what do to after a new version is created.
To add a rule, you only need to choose a pattern and an action.
After that, every new tag or branch that matches the pattern will trigger the action.</p>
<img alt="../../../_images/automation-rule.png" src="../../../_images/automation-rule.png" style="width: 100%;" />
<p>Currently, we only have two actions available:</p>
<ul class="simple">
<li><p>Activate version</p></li>
<li><p>Set version as default</p></li>
</ul>
<p>For the pattern, you can select:</p>
<ul class="simple">
<li><p>All versions</p></li>
<li><p>The ones that match SemVer</p></li>
<li><p>Or you can write your own using a regular expression</p></li>
</ul>
<p>With automation rules you can do things like:</p>
<ul class="simple">
<li><p>Activate new tags only</p></li>
<li><p>Activate only branches that start with <code class="docutils literal notranslate"><span class="pre">v</span></code></p></li>
<li><p>Activate tags and branches that belong to the <code class="docutils literal notranslate"><span class="pre">1.x</span></code> release</p></li>
<li><p>Set as default tags that have the <code class="docutils literal notranslate"><span class="pre">-stable</span></code> or <code class="docutils literal notranslate"><span class="pre">-release</span></code> suffix</p></li>
<li><p>Activate all tags except those containing the <code class="docutils literal notranslate"><span class="pre">--nightly</span></code> suffix</p></li>
</ul>
<p>Find more information and examples in <a class="reference external" href="https://docs.readthedocs.io/en/stable/automation-rules.html" title="(in Read the Docs user documentation v9.15.0)"><span class="xref std std-doc">our documentation</span></a>.</p>
<p>What other tasks you would like to automate?
Let us know on a <a class="reference external" href="https://github.com/readthedocs/readthedocs.org/issues/">GitHub issue</a>!</p>
<dl class="footnote brackets">
<dt class="label" id="id2"><span class="brackets"><a class="fn-backref" href="#id1">1</a></span></dt>
<dd><p>We activate and build new versions automatically only if you follow <span class="target" id="index-0"></span><a class="pep reference external" href="https://peps.python.org/pep-0440/"><strong>PEP 440</strong></a>,
and the new version is greater than the current stable version.</p>
</dd>
</dl>
</section>
A time ago we introduced a new feature to help users to automate some tasks on Read the Docs.
Automation rules.If you manage a project with several versions,
you may have noticed that Read the Docs doesn’t always activate your new versions 1.
If you require to do any action over a new version,
you’ll need to log in your Read the Docs account and manually do so.2020-05-04T00:00:00+00:00