how can I specify the branches for a merge request approval rule? #3225

guerda · 2025-06-27T12:09:26Z

guerda
Jun 27, 2025

I would like to automatically create a merge request approval rule.
Unfortunately, I don't find an option to specify which branch this applies to.
Using this code always leads to a rule applying to all branches

project.approvalrules.create(
            {
                "name": rule_name,
                "approvals_required": 1,
                "rule_type": "regular",
                "branches": ["main"], # This does not have an effect.
                "group_ids": approver_group_ids,
            })

Any idea how to fix this?

Answered by guerda

Jun 27, 2025

I found a solution

project = gl.projects.get("my-project")
main_branch = project.protectedbranches.get("main")
project.approvalrules.create(
                {
                    "name": rule_name,
                    "approvals_required": 1,
                    "rule_type": "regular",
                    "protected_branch_ids": [main_branch_id.id],
                    "group_ids": approver_group_ids,
                }
            )

View full answer

guerda · 2025-06-27T12:30:32Z

guerda
Jun 27, 2025
Author

I'm not sure if this is even supported by the GitLab API: https://archives.docs.gitlab.com/17.11/api/merge_request_approvals/#create-project-approval-rule
Related forum posting: https://forum.gitlab.com/t/how-can-i-specify-the-branches-for-a-merge-request-approval-rule/127624

0 replies

guerda · 2025-06-27T13:23:31Z

guerda
Jun 27, 2025
Author

I found a solution

project = gl.projects.get("my-project")
main_branch = project.protectedbranches.get("main")
project.approvalrules.create(
                {
                    "name": rule_name,
                    "approvals_required": 1,
                    "rule_type": "regular",
                    "protected_branch_ids": [main_branch_id.id],
                    "group_ids": approver_group_ids,
                }
            )

0 replies

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

how can I specify the branches for a merge request approval rule? #3225

Uh oh!

{{title}}

Uh oh!

Replies: 2 comments

Uh oh!

{{title}}

Uh oh!

Uh oh!

{{editor}}'s edit

{{editor}}'s edit

Uh oh!

Uh oh!

{{title}}

Uh oh!

Select a reply

Uh oh!

how can I specify the branches for a merge request approval rule? #3225

Uh oh!

guerda Jun 27, 2025

Replies: 2 comments

Uh oh!

Uh oh!

guerda Jun 27, 2025 Author

Uh oh!

guerda Jun 27, 2025 Author

guerda
Jun 27, 2025

guerda
Jun 27, 2025
Author

guerda
Jun 27, 2025
Author