Gitlab: Don't try to delete "report_approver" type when "gitLabIgnoreApprovals" is activated

[nicolas-urbantz]

Tell us more.

Hello,

I'm running into a blocker while I'm using renovate. Here is the context:

We are using gitlab and we want to activate the "automerge" on some PR. The problem is that we also activated the "report_approver" rule that can't be deleted through an API call (see documentation.

The good news is that, by putting renovate bot in the "report_approver" group and by asking it to autoApprove=true, our MR's can be auto merge :) BUT we also have another rule saying "we need 2 approvals", that should be removed.

I've checked in the code, and it seems we try to delete rules that we can't here:

    const existingRegularApproverRules = rules?.filter(
      ({ rule_type, name }) =>
        rule_type !== 'any_approver' && name !== ruleName,
    );

    if (existingRegularApproverRules?.length) {
      await p.all(
        existingRegularApproverRules.map((rule) => async (): Promise<void> => {
          await gitlabApi.deleteJson(`${url}/${rule.id}`);
        }),
      );
    }

And it's only AFTER this loop that we set approvals_required: 0.

So my idea would be to add filters in existingRegularApproverRules so that it doesn't fail on await gitlabApi.deleteJson(${url}/${rule.id});, so that the code that put approvals_required: 0 is reached.

What do you think?

ps: I can propose a MR if you are ok with the idea

[rarkins]

Is your solution to:

• Apply more filtering, so that the problematic rule isn't attempted to be deleted? or
• Add try/catch so we that we ignore failed deletion attempts?

[nicolas-urbantz]

I would apply more filtering. Because if we hide the error triggered by the deleteJson, we won't see an error in the dashboard I guess? I would be nice to keep this feedback.

Also, adding a filter means less API call (that we know will fail anyway...)

[rarkins]

And would every GitLab user want/benefit from the extra filtering or could it "break" some who need this deleted?

[nicolas-urbantz]

From the doc of gitlab, we can see:

Important: Deleting a report_approver or code_owner rule is not allowed. These are system generated rules.

So I think it never worked since those 2 rules were added by gitlab. The deleteJson will always fail for those 2 (until gitlab allows it one day of course)

[rarkins]

PR welcome!

[Nikoms]

I hope it's good enough :) => #27963