feat: Add organization-level presets (#7403)

Co-authored-by: Michael Kriese <[email protected]>
Co-authored-by: Rhys Arkins <[email protected]>

docs/usage/config-presets.md

@@ -179,3 +179,7 @@ The answer is to host your preset using GitHub or GitLab - not npmjs - and make
 ## Contributing to presets
 
 Have you configured a rule that you think others might benefit from? Please consider contributing it to the [Renovate](https://github.com/renovatebot/renovate) repository so that it gains higher visibility and saves others from reinventing the same thing.
+
+## Organisation level presets
+
+When repository onboarding happens, if a repository called `renovate-config` exists under the same organization and contains a default Renovate preset, that repository will be suggested as the the sole extended preset, and any existing `onboardingConfig` config will be ignored/overriden. This allows for a seamless onboarding workflow with your own organization settings.

lib/config/common.ts

@@ -18,6 +18,7 @@ export interface GroupConfig extends Record<string, unknown> {
 
 // TODO: Proper typings
 export interface RenovateSharedConfig {
+  $schema?: string;
   automerge?: boolean;
   branchPrefix?: string;
   branchName?: string;
@@ -27,6 +28,7 @@ export interface RenovateSharedConfig {
   draftPR?: boolean;
   enabled?: boolean;
   enabledManagers?: string[];
+  extends?: string[];
   fileMatch?: string[];
   group?: GroupConfig;
   groupName?: string;
@@ -145,7 +147,6 @@ export interface RenovateConfig
   description?: string | string[];
 
   errors?: ValidationMessage[];
-  extends?: string[];
 
   gitAuthor?: string;
 

lib/config/presets/internal/default.ts

@@ -351,15 +351,15 @@ export const presets: Record<string, Preset> = {
     description: 'Run lock file maintenance (updates) early Monday mornings',
     lockFileMaintenance: {
       enabled: true,
-      extends: 'schedule:weekly',
+      extends: ['schedule:weekly'],
     },
   },
   maintainLockFilesMonthly: {
     description:
       'Run lock file maintenance (updates) on the first day of each month',
     lockFileMaintenance: {
       enabled: true,
-      extends: 'schedule:monthly',
+      extends: ['schedule:monthly'],
     },
   },
   ignoreUnstable: {

lib/workers/repository/onboarding/branch/config.spec.ts

@@ -0,0 +1,43 @@
+import { RenovateConfig, getConfig } from '../../../../../test/util';
+import * as presets from '../../../../config/presets';
+import { PRESET_DEP_NOT_FOUND } from '../../../../config/presets/util';
+import { getOnboardingConfig } from './config';
+
+jest.mock('../../../../config/presets');
+
+const mockedPresets = presets as jest.Mocked<typeof presets>;
+
+describe('workers/repository/onboarding/branch', () => {
+  let config: RenovateConfig;
+  let onboardingConfig: string;
+  beforeEach(() => {
+    jest.clearAllMocks();
+    config = getConfig();
+    config.repository = 'some/repo';
+  });
+  describe('getOnboardingConfig', () => {
+    it('handles finding an organization preset', async () => {
+      onboardingConfig = await getOnboardingConfig(config);
+      expect(mockedPresets.getPreset).toHaveBeenCalledTimes(1);
+      expect(JSON.parse(onboardingConfig).extends[0]).toEqual(
+        'local>some/renovate-config'
+      );
+    });
+    it('handles not finding an organization preset', async () => {
+      mockedPresets.getPreset.mockRejectedValue(
+        new Error(PRESET_DEP_NOT_FOUND)
+      );
+      onboardingConfig = await getOnboardingConfig(config);
+      expect(mockedPresets.getPreset).toHaveBeenCalledTimes(1);
+      expect(JSON.parse(onboardingConfig)).toEqual(config.onboardingConfig);
+    });
+    it('ignores an unknown error', async () => {
+      mockedPresets.getPreset.mockRejectedValue(
+        new Error('unknown error for test')
+      );
+      onboardingConfig = await getOnboardingConfig(config);
+      expect(mockedPresets.getPreset).toHaveBeenCalledTimes(1);
+      expect(JSON.parse(onboardingConfig)).toEqual(config.onboardingConfig);
+    });
+  });
+});

lib/workers/repository/onboarding/branch/config.ts

@@ -1,9 +1,35 @@
 import { RenovateConfig } from '../../../../config';
+import { getPreset } from '../../../../config/presets';
+import { PRESET_DEP_NOT_FOUND } from '../../../../config/presets/util';
 import { logger } from '../../../../logger';
 import { clone } from '../../../../util/clone';
 
-export function getOnboardingConfig(config: RenovateConfig): string {
-  const onboardingConfig = clone(config.onboardingConfig);
+export async function getOnboardingConfig(
+  config: RenovateConfig
+): Promise<string> {
+  let onboardingConfig = clone(config.onboardingConfig);
+
+  let organizationConfigRepoExists = false;
+  const organizationConfigPresetName = `local>${
+    config.repository.split('/')[0]
+  }/renovate-config`;
+
+  try {
+    await getPreset(organizationConfigPresetName, config);
+    organizationConfigRepoExists = true;
+  } catch (err) {
+    if (err.message !== PRESET_DEP_NOT_FOUND) {
+      logger.warn({ err }, 'Unknown error fetching default owner preset');
+    }
+    // Organization preset did not exist
+  }
+  if (organizationConfigRepoExists) {
+    onboardingConfig = {
+      $schema: 'https://docs.renovatebot.com/renovate-schema.json',
+      extends: [organizationConfigPresetName],
+    };
+  }
+
   logger.debug({ config: onboardingConfig }, 'onboarding config');
   return JSON.stringify(onboardingConfig, null, 2) + '\n';
 }

lib/workers/repository/onboarding/branch/create.ts

@@ -7,11 +7,11 @@ import { getOnboardingConfig } from './config';
 
 const defaultConfigFile = configFileNames[0];
 
-export function createOnboardingBranch(
+export async function createOnboardingBranch(
   config: Partial<RenovateConfig>
 ): Promise<string | null> {
   logger.debug('createOnboardingBranch()');
-  const contents = getOnboardingConfig(config);
+  const contents = await getOnboardingConfig(config);
   logger.debug('Creating onboarding branch');
 
   let commitMessagePrefix = '';

lib/workers/repository/onboarding/branch/index.spec.ts

@@ -23,6 +23,7 @@ describe('workers/repository/onboarding/branch', () => {
     beforeEach(() => {
       jest.resetAllMocks();
       config = getConfig();
+      config.repository = 'some/repo';
       git.getFileList.mockResolvedValue([]);
     });
     it('throws if no package files', async () => {

lib/workers/repository/onboarding/branch/rebase.spec.ts

@@ -10,6 +10,7 @@ describe('workers/repository/onboarding/branch/rebase', () => {
       jest.resetAllMocks();
       config = {
         ...defaultConfig,
+        repository: 'some/repo',
       };
     });
     it('does not rebase modified branch', async () => {

lib/workers/repository/onboarding/branch/rebase.ts

@@ -39,7 +39,7 @@ export async function rebaseOnboardingBranch(
     defaultConfigFile,
     config.onboardingBranch
   );
-  const contents = getOnboardingConfig(config);
+  const contents = await getOnboardingConfig(config);
   if (
     contents === existingContents &&
     !(await isBranchStale(config.onboardingBranch))