Read the Docs Blog - Posts tagged automation-ruleshttps://blog.readthedocs.com/archive/tag/automation-rules/atom.xml2020-05-04T00:00:00ZABlogAutomation Ruleshttps://blog.readthedocs.com/automation-rules/2020-05-04T00:00:00Z2020-05-04T00:00:00ZSantos Gallegos<div class="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 v7.4.1)"><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" 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>Activate version</li>
<li>Set version as default</li>
</ul>
<p>For the pattern, you can select:</p>
<ul class="simple">
<li>All versions</li>
<li>The ones that match SemVer</li>
<li>Or you can write your own using a regular expression</li>
</ul>
<p>With automation rules you can do things like:</p>
<ul class="simple">
<li>Activate new tags only</li>
<li>Activate only branches that start with <code class="docutils literal notranslate"><span class="pre">v</span></code></li>
<li>Activate tags and branches that belong to the <code class="docutils literal notranslate"><span class="pre">1.x</span></code> release</li>
<li>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</li>
<li>Activate all tags except those containing the <code class="docutils literal notranslate"><span class="pre">--nightly</span></code> suffix</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 v7.4.1)"><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>
<table class="docutils footnote" frame="void" id="id2" rules="none">
<colgroup><col class="label" /><col /></colgroup>
<tbody valign="top">
<tr><td class="label"><a class="fn-backref" href="#id1">[1]</a></td><td>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://www.python.org/dev/peps/pep-0440"><strong>PEP 440</strong></a>,
and the new version is greater than the current stable version.</td></tr>
</tbody>
</table>
</div>