Builds: automation rules v2 by humitos · Pull Request #12848 · readthedocs/readthedocs.org

humitos · 2026-03-16T15:49:21Z

This is the initial proposal to migrate our current VersionAutomationRules and RegexAutomationRules to only one model called AutomationRule as discussed.

I created a basic UI just to be able to use the feature; but we need to work on ext-theme for that. I think it won't be a lot of work, but we need:

version_types should be a multi-select field
version_match_pattern should be shown/hidden based on another input value

List view	Detail view

Closes Build: webhook filters v2 #12788
Related Filter builds based on GHA webhook path filtering rules #12697
Related Automation rule: Webhook filtering by files changed in the commit #12715
Requires: Automation rules v2: list and details ext-theme#720

humitos · 2026-03-17T11:19:56Z

@copilot can you create a new PR based on this one to update the test cases matching the code changes?

Copilot · 2026-03-17T11:20:03Z

@humitos I've opened a new pull request, #12850, to work on those changes. Once the pull request is ready, I'll request review from you.

readthedocs/builds/forms.py

read-the-docs-community · 2026-03-17T15:13:13Z

Documentation build overview

📚 dev | 🛠️ Build #32186922 | 📁 Comparing d46be50 against latest (50e8d78)

🔍 Preview build

Show files changed (2 files in total): 📝 2 modified | ➕ 0 added | ➖ 0 deleted

File	Status
aws-temporary-credentials.html	📝 modified
tests.html	📝 modified

humitos · 2026-03-17T15:16:17Z

readthedocs/builds/models.py

            return diff.seconds


 class VersionAutomationRule(PolymorphicModel, TimeStampedModel):


I will delete this model in a following PR and migration. We are not using it anymore.

readthedocs/builds/models.py

readthedocs/readthedocs.org#12848

stsewd

Looks like this is missing moving the models and forms to the projects app.

readthedocs/builds/constants.py

readthedocs/builds/forms.py

readthedocs/builds/models.py

stsewd · 2026-04-02T18:01:09Z

readthedocs/oauth/tasks.py

+                            rule_triggered_for_project = True
+                            rule_triggered_for_version = True
                            rule.run(version)

-                        # We only trigger the first matching rule,
+                        # We only trigger the first matching rule per version
                        # to avoid triggering multiple builds for the same tag/branches.
-                        break
+                        if rule_triggered_for_version:
+                            break


There is no need to track this in two variables. Since you only want to know if at least one rule matched, you can use a single variable.

Suggested change

rule_triggered_for_project = True

rule_triggered_for_version = True

rule.run(version)

# We only trigger the first matching rule,

# We only trigger the first matching rule per version

# to avoid triggering multiple builds for the same tag/branches.

break

if rule_triggered_for_version:

break

rule_triggered = True

rule.run(version)

# We only trigger the first matching rule per version

# to avoid triggering multiple builds for the same tag/branches.

break

We need to check all the rules for all the versions. Using only one variable, if the first rule is triggered on the first version, we will be skipping the other versions.

readthedocs/oauth/tasks.py

This reverts commit 19b5ada.

agjohnson

There's some needed on the UI side but overall this looks good.

readthedocs/projects/models.py

readthedocs/builds/constants.py

readthedocs/projects/migrations/0159_add_automationrule_v2.py

agjohnson · 2026-04-08T20:25:51Z

readthedocs/projects/forms.py

+    project = forms.CharField(widget=forms.HiddenInput(), required=False)
+
+    VERSION_TYPE_CHOICES = [
+        RichChoice(text=name, value=value, description="description", disabled=False)


Note to update the description here. The description is a good place to describe the types in more detail, instead of cramming that information into the option name.

I added description because it was mandatory, basically. I don't know what could be a good description here. They are just version types 🤷🏼 . Do you have any suggestion for each of them?

Description is the main reason to use RichSelect. Otherwise if you just need a basic list of items you would just continue using a basic select widget. RichSelect is only needed if you want additional information like a description or image with each option.

In this case, there is a Django multi select widget that you probably want to use. I`m pretty sure we've used it elsewhere, I think with team project selection -- if you need an example.

Yeah, I only want a multi select field, but I wasn't able to find an example where we use it. I want exactly what I posted in the video (#12848 (comment)) but without the description.

Great! I found the example you said...

I will check its code and update this PR. 👍🏼

agjohnson · 2026-04-08T20:27:34Z

readthedocs/projects/forms.py

+class CommaSeparatedMultipleChoiceField(forms.MultipleChoiceField):
+    """Handle comma-separated values for a single hidden input."""
+
+    hidden_widget = forms.HiddenInput
+
+    def to_python(self, value):
+        if isinstance(value, str):
+            value = [item.strip() for item in value.split(",") if item.strip()]
+        return super().to_python(value)
+
+    def prepare_value(self, value):
+        if isinstance(value, (list, tuple)):
+            return ",".join(value)
+        return super().prepare_value(value)


Why is this a comma separated value? It's not really clear what UX you're aiming for here, but I think you likely want something that SUI already gives us.

I had to use a comma separated value because of SUI actually 😄 . That's how it handle multiple choice fields. It ends up with value=branch,tag

The UX is to be able to select multiple items. It works as I want now:

Peek.2026-04-09.10-59.webm

Yeah that looks great. There are other options for getting that data into the SUI module without altering the data on the application side. But the effect is identical either way.

humitos added 20 commits March 5, 2026 13:22

Initial implementation by the AI

04c195d

Update models slightly

c934777

Initial implementation

4c7bde8

Make the implementation to work

fb2c5db

Migration

79eb0eb

Remove AI created files

1159803

Merge branch 'main' into humitos/webhook-filters-v2

93d97ea

Small refactor

8712a6f

Minor changes

eea2d6b

Order and log

4474989

Support predefined values for version pattern

e46aa93

Update migrations file to reflect changes and add data migration

3943c66

Update logs

3e4d7a4

Version types

b09f269

Add move priority support

6afb742

Update migration to match code

1bef78d

Update version match

0f648d1

Remove comment

41d9e1e

Placeholder

ebaa6da

Filter by enabled/disabled

b13288c

Copilot AI mentioned this pull request Mar 17, 2026

Tests: update automation rules test suite for v2 model #12850

Draft

Update logs

8a7b891

humitos commented Mar 17, 2026

View reviewed changes

readthedocs/builds/forms.py Outdated Show resolved Hide resolved

Add a comment about AutomationRuleMatch metadata

0ee7125

humitos commented Mar 17, 2026

View reviewed changes

humitos added 2 commits March 17, 2026 16:27

Re-use constants

80fc1fd

Validate version matching

21d86fa

humitos marked this pull request as ready for review March 17, 2026 16:56

humitos requested a review from a team as a code owner March 17, 2026 16:56

humitos requested a review from stsewd March 17, 2026 16:56

auto-assign bot assigned humitos Mar 17, 2026

humitos requested review from agjohnson and ericholscher March 17, 2026 16:56

stsewd reviewed Mar 25, 2026

View reviewed changes

humitos added 3 commits March 30, 2026 16:58

Use explicit custom-match value instead of None

7221502

Update based on feedback

8bdaa4d

Update code based on feedback

3f9b6bd

humitos requested a review from stsewd April 2, 2026 15:01

humitos added a commit to readthedocs/ext-theme that referenced this pull request Apr 2, 2026

Automation rules v2: list and details

df83832

readthedocs/readthedocs.org#12848

humitos mentioned this pull request Apr 2, 2026

Automation rules v2: list and details readthedocs/ext-theme#720

Open

Attempt to use RichSelect and RichChoice

23c9852

stsewd reviewed Apr 2, 2026

View reviewed changes

humitos added 13 commits April 7, 2026 15:31

Move forms to projects/forms.py

f106ecd

Move AutomationRule to projects app

a423f16

Fix some issues after moving the model

d5fa131

Handle custom match

f82d613

Update reference to model

d9fe37f

Get commit from pull request

71964c5

Split .match into .match_version and .match_webhook

a6d9473

Split match_webhook into 3 different helper methods

d60d079

Update migrations

897dc44

Pass use_data_binding to make the field work properly

8a97671

Override hidden widget to allow multiplechoice

19b5ada

Use a custom field to handle multichoice select with RichSelect

dcfc5ff

Revert "Override hidden widget to allow multiplechoice"

12cd37e

This reverts commit 19b5ada.

agjohnson approved these changes Apr 8, 2026

View reviewed changes

Move data migration to another migration file

d46be50

		return diff.seconds


		class VersionAutomationRule(PolymorphicModel, TimeStampedModel):

Uh oh!

Conversation

humitos commented Mar 16, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

humitos commented Mar 17, 2026

Uh oh!

Copilot AI commented Mar 17, 2026

Uh oh!

Uh oh!

read-the-docs-community bot commented Mar 17, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Documentation build overview

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

stsewd left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

agjohnson left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

humitos commented Mar 16, 2026 •

edited

Loading

read-the-docs-community bot commented Mar 17, 2026 •

edited

Loading