From bce88c862e4fd7269f2175b698b52c05df6cdbd4 Mon Sep 17 00:00:00 2001 From: Michael Kriese Date: Tue, 18 Apr 2023 11:09:46 +0200 Subject: [PATCH] feat(config): rename `azureAutoApprove` to `autoApprove` (#21576) --- docs/usage/configuration-options.md | 12 ++++++------ lib/config/migrations/migrations-service.ts | 1 + lib/config/options/index.ts | 4 ++-- lib/modules/platform/azure/index.spec.ts | 2 +- lib/modules/platform/azure/index.ts | 2 +- lib/modules/platform/types.ts | 2 +- lib/workers/repository/update/pr/index.ts | 2 +- 7 files changed, 13 insertions(+), 12 deletions(-) diff --git a/docs/usage/configuration-options.md b/docs/usage/configuration-options.md index 690946388fb538..7c3d6da94ed3d3 100644 --- a/docs/usage/configuration-options.md +++ b/docs/usage/configuration-options.md @@ -119,6 +119,12 @@ See [GitHub](https://docs.github.com/en/repositories/managing-your-repositorys-s If configured, Renovate will take a random sample of given size from assignees and assign them only, instead of assigning the entire list of `assignees` you have configured. +## autoApprove + +Setting this to `true` will automatically approve the PRs. + +You can also configure this using `packageRules` if you want to use it selectively (e.g. per-package). + ## autoReplaceGlobalMatch Setting this to `false` will replace only the first match during replacements updates. @@ -258,12 +264,6 @@ If you prefer that Renovate more silently automerge _without_ Pull Requests at a The final value for `automergeType` is `"pr-comment"`, intended only for users who already have a "merge bot" such as [bors-ng](https://github.com/bors-ng/bors-ng) and want Renovate to _not_ actually automerge by itself and instead tell `bors-ng` to merge for it, by using a comment in the PR. If you're not already using `bors-ng` or similar, don't worry about this option. -## azureAutoApprove - -Setting this to `true` will automatically approve the PRs in Azure DevOps. - -You can also configure this using `packageRules` if you want to use it selectively (e.g. per-package). - ## azureWorkItemId When creating a PR in Azure DevOps, some branches can be protected with branch policies to [check for linked work items](https://docs.microsoft.com/en-us/azure/devops/repos/git/branch-policies?view=azure-devops#check-for-linked-work-items). diff --git a/lib/config/migrations/migrations-service.ts b/lib/config/migrations/migrations-service.ts index 08177481823d1f..1b6c0d357d515f 100644 --- a/lib/config/migrations/migrations-service.ts +++ b/lib/config/migrations/migrations-service.ts @@ -76,6 +76,7 @@ export class MigrationsService { static readonly renamedProperties: ReadonlyMap = new Map([ ['adoptium-java', 'java-version'], + ['azureAutoApprove', 'autoApprove'], ['endpoints', 'hostRules'], ['excludedPackageNames', 'excludePackageNames'], ['exposeEnv', 'exposeAllEnv'], diff --git a/lib/config/options/index.ts b/lib/config/options/index.ts index ae357e8d09f572..bc8561377fbd7b 100644 --- a/lib/config/options/index.ts +++ b/lib/config/options/index.ts @@ -925,8 +925,8 @@ const options: RenovateOptions[] = [ supportedPlatforms: ['azure'], }, { - name: 'azureAutoApprove', - description: 'Set to `true` to automatically approve Azure DevOps PRs.', + name: 'autoApprove', + description: 'Set to `true` to automatically approve PRs.', type: 'boolean', default: false, supportedPlatforms: ['azure'], diff --git a/lib/modules/platform/azure/index.spec.ts b/lib/modules/platform/azure/index.spec.ts index 511bf8210e4f71..da8a998a7b702e 100644 --- a/lib/modules/platform/azure/index.spec.ts +++ b/lib/modules/platform/azure/index.spec.ts @@ -805,7 +805,7 @@ describe('modules/platform/azure/index', () => { prTitle: 'The Title', prBody: 'Hello world', labels: ['deps', 'renovate'], - platformOptions: { azureAutoApprove: true }, + platformOptions: { autoApprove: true }, }); expect(updateFn).toHaveBeenCalled(); expect(pr).toMatchSnapshot(); diff --git a/lib/modules/platform/azure/index.ts b/lib/modules/platform/azure/index.ts index 73b1a4e23366b2..b1eb1430369d14 100644 --- a/lib/modules/platform/azure/index.ts +++ b/lib/modules/platform/azure/index.ts @@ -472,7 +472,7 @@ export async function createPr({ pr.pullRequestId! ); } - if (platformOptions?.azureAutoApprove) { + if (platformOptions?.autoApprove) { await azureApiGit.createPullRequestReviewer( { reviewerUrl: pr.createdBy!.url, diff --git a/lib/modules/platform/types.ts b/lib/modules/platform/types.ts index d37eae8db6c50a..188e50b125c041 100644 --- a/lib/modules/platform/types.ts +++ b/lib/modules/platform/types.ts @@ -88,7 +88,7 @@ export interface Issue { title?: string; } export type PlatformPrOptions = { - azureAutoApprove?: boolean; + autoApprove?: boolean; azureWorkItemId?: number; bbUseDefaultReviewers?: boolean; gitLabIgnoreApprovals?: boolean; diff --git a/lib/workers/repository/update/pr/index.ts b/lib/workers/repository/update/pr/index.ts index 94292fce88f916..bc3c9b2adebccb 100644 --- a/lib/workers/repository/update/pr/index.ts +++ b/lib/workers/repository/update/pr/index.ts @@ -50,7 +50,7 @@ export function getPlatformPrOptions( ); return { - azureAutoApprove: !!config.azureAutoApprove, + autoApprove: !!config.autoApprove, azureWorkItemId: config.azureWorkItemId ?? 0, bbUseDefaultReviewers: !!config.bbUseDefaultReviewers, gitLabIgnoreApprovals: !!config.gitLabIgnoreApprovals,