Automation rules allow project maintainers to automate actions on new branches and tags on repositories.
Creating an automation rule¶
Go to your project dashboard
Click Admin > Automation Rules
Click on Add Rule
Fill in the fields
How do they work?¶
When a new tag or branch is pushed to your repository, Read the Docs creates a new version.
All rules are evaluated for this version, in the order they are listed. If the version matches the version type and the pattern in the rule, the specified action is performed on that version.
Versions can match multiple rules, and all matching actions will be performed on the version.
Automation rules support several predefined version matches:
Any version: All new versions will match the rule.
SemVer versions: All new versions that follow semantic versioning will match the rule.
User defined matches¶
If none of the above predefined matches meet your use case, you can use a Custom match.
The custom match should be a valid Python regular expression. Each new version will be tested against this regular expression.
When a rule matches a new version, the specified action is performed on that version. Currently, the following actions are available:
Activate version: Activates and builds the version.
Hide version: Hides the version. If the version is not active, activates it and builds the version. See Version States.
Make version public: Sets the version’s privacy level to public. See Privacy levels.
Make version private: Sets the version’s privacy level to private. See Privacy levels.
Set version as default: Sets the version as default, i.e. the version of your project that
/redirects to. See more in Root URL. It also activates and builds the version.
Delete version: When a branch or tag is deleted from your repository, Read the Docs will delete it only if isn’t active. This action allows you to delete active versions when a branch or tag is deleted from your repository.
The default version isn’t deleted even if it matches a rule. You can use the
Set version as defaultaction to change the default version before deleting the current one.
The order your rules are listed in Admin > Automation Rules matters. Each action will be performed in that order, so first rules have a higher priority.
You can change the order using the up and down arrow buttons.
New rules are added at the end (lower priority).