feat(config/migration): migrate config with a PR

lib/config/options/index.ts

@@ -120,7 +120,20 @@ const options: RenovateOptions[] = [
       'Change this value in order to override the default onboarding PR title.',
     type: 'string',
     default: 'Configure Renovate',
-    globalOnly: true,
+    cli: false,
+  },
+  {
+    name: 'configMigration',
+    description: 'Enable this to get Config migration PRs when needed.',
+    type: 'boolean',
+    default: false,
+  },
+  {
+    name: 'configMigrationBranch',
+    description:
+      'Change this value in order to override the default config migration branch name.',
+    type: 'string',
+    default: '{{{branchPrefix}}}migrate-config',
     cli: false,
   },
   {

lib/config/types.ts

@@ -134,6 +134,7 @@ export interface LegacyAdminConfig {
   platform?: string;
   requireConfig?: boolean;
 }
+
 export type ExecutionMode = 'branch' | 'update';
 
 export type PostUpgradeTasks = {
@@ -171,6 +172,7 @@ export interface RenovateConfig
     RenovateSharedConfig,
     UpdateConfig<PackageRule>,
     AssigneesAndReviewersConfig,
+    ConfigMigration,
     Record<string, unknown> {
   depName?: string;
   baseBranches?: string[];
@@ -409,6 +411,11 @@ export interface PackageRuleInputConfig extends Record<string, unknown> {
   packageRules?: (PackageRule & PackageRuleInputConfig)[];
 }
 
+export interface ConfigMigration {
+  configMigration?: boolean;
+  configMigrationBranch?: string;
+}
+
 export interface MigratedConfig {
   isMigrated: boolean;
   migratedConfig: RenovateConfig;

lib/util/template/index.ts

@@ -136,6 +136,8 @@ const prBodyFields = [
   'table',
   'notes',
   'changelogs',
+  'errors',
+  'warnings',
   'configDescription',
   'controls',
   'footer',

lib/workers/repository/config-migration/branch/commit-message.ts

@@ -0,0 +1,40 @@
+import type { RenovateConfig } from '../../../../config/types';
+import * as template from '../../../../util/template';
+
+export class ConfigMigrationCommitMessageFactory {
+  private readonly config: RenovateConfig;
+
+  private readonly configFile: string;
+
+  constructor(config: RenovateConfig, configFile: string) {
+    this.config = config;
+    this.configFile = configFile;
+  }
+
+  create(): string {
+    const { commitMessagePrefix, commitMessage, semanticCommitType } =
+      this.config;
+    let prefix: string | null = null;
+
+    if (commitMessagePrefix) {
+      prefix = (commitMessagePrefix ?? '').trim();
+    } else if (this.areSemanticCommitsEnabled()) {
+      prefix = (semanticCommitType ?? '').trim() + '(config)';
+    }
+
+    return template.compile(
+      commitMessage ?? `Migrate config ${this.configFile}`,
+      {
+        ...this.config,
+        commitMessagePrefix: prefix ?? '',
+        commitMessageAction: 'Migrate',
+        commitMessageTopic: `config ${this.configFile}`,
+        commitMessageExtra: '',
+      }
+    );
+  }
+
+  private areSemanticCommitsEnabled(): boolean {
+    return this.config.semanticCommits === 'enabled';
+  }
+}

lib/workers/repository/config-migration/branch/create.ts

@@ -0,0 +1,44 @@
+import { GlobalConfig } from '../../../../config/global';
+import type { RenovateConfig } from '../../../../config/types';
+import { logger } from '../../../../logger';
+import { commitAndPush } from '../../../../modules/platform/commit';
+import { setGitAuthor } from '../../../../util/git';
+import { ConfigMigrationCommitMessageFactory } from './commit-message';
+import type { MigratedData } from './migrated-data';
+
+export function createConfigMigrationBranch(
+  config: Partial<RenovateConfig>,
+  migratedConfigData: MigratedData
+): Promise<string | null> {
+  logger.debug('createConfigMigrationBranch()');
+  const contents = migratedConfigData.getConfigContent();
+  const configFileName = migratedConfigData.getConfigFileName();
+  logger.debug('Creating config migration branch');
+
+  const commitMessageFactory = new ConfigMigrationCommitMessageFactory(
+    config,
+    configFileName
+  );
+
+  const commitMessage = commitMessageFactory.create();
+
+  // istanbul ignore if
+  if (GlobalConfig.get('dryRun')) {
+    logger.info('DRY-RUN: Would commit files to config migration branch');
+    return null;
+  }
+
+  setGitAuthor(config.gitAuthor);
+  return commitAndPush({
+    branchName: config.configMigrationBranch,
+    files: [
+      {
+        type: 'addition',
+        path: configFileName,
+        contents,
+      },
+    ],
+    message: commitMessage.toString(),
+    platformCommit: !!config.platformCommit,
+  });
+}

lib/workers/repository/config-migration/branch/index.ts

@@ -0,0 +1,62 @@
+import { GlobalConfig } from '../../../../config/global';
+import type { RenovateConfig } from '../../../../config/types';
+import { logger } from '../../../../logger';
+import { platform } from '../../../../modules/platform';
+import { checkoutBranch } from '../../../../util/git';
+import * as template from '../../../../util/template';
+import { createConfigMigrationBranch } from './create';
+import { MigratedDataFactory } from './migrated-data';
+import { rebaseMigrationBranch } from './rebase';
+
+export async function checkConfigMigrationBranch(
+  config: RenovateConfig
+): Promise<RenovateConfig> {
+  logger.debug('checkConfigMigrationBranch()');
+  logger.trace({ config });
+  const migratedConfigData = await MigratedDataFactory.getAsync(config);
+  if (!migratedConfigData) {
+    logger.debug('checkConfigMigrationBranch() Error fetching migrated data');
+    return config;
+  }
+  config.configMigrationBranch = template.compile(
+    config.configMigrationBranch,
+    config
+  );
+  const configMigrationBranch = config.configMigrationBranch;
+  if (await migrationPrExists(config)) {
+    logger.debug('Config Migration PR already exists');
+    const commit = await rebaseMigrationBranch(config, migratedConfigData);
+    if (commit) {
+      logger.info({ branch: configMigrationBranch, commit }, 'Branch updated');
+    }
+    // istanbul ignore if
+    if (platform.refreshPr) {
+      const configMigrationPr = await platform.getBranchPr(
+        configMigrationBranch
+      );
+      await platform.refreshPr(configMigrationPr.number);
+    }
+  } else {
+    logger.debug('Config Migration PR does not exist');
+    logger.debug('Need to create migration PR');
+    const commit = await createConfigMigrationBranch(
+      config,
+      migratedConfigData
+    );
+    // istanbul ignore if
+    if (commit) {
+      logger.info({ branch: configMigrationBranch, commit }, 'Branch created');
+    }
+  }
+  if (!GlobalConfig.get('dryRun')) {
+    await checkoutBranch(configMigrationBranch);
+  }
+  MigratedDataFactory.reset();
+  const branchList = [configMigrationBranch];
+  return { ...config, configMigrationBranch, branchList };
+}
+
+export const migrationPrExists = async (
+  config: RenovateConfig
+): Promise<boolean> =>
+  !!(await platform.getBranchPr(config.configMigrationBranch));

lib/workers/repository/config-migration/branch/migrated-data.ts

@@ -0,0 +1,89 @@
+import detectIndent from 'detect-indent';
+import { migrateAndValidate } from '../../../../config/migrate-validate';
+import type { RenovateConfig } from '../../../../config/types';
+import { logger } from '../../../../logger';
+import { readLocalFile } from '../../../../util/fs';
+import { detectRepoFileConfig } from '../../init/merge';
+
+export class MigratedData {
+  constructor(
+    private readonly _content: string,
+    private readonly _fileName: string,
+    private readonly _indent: string
+  ) {}
+
+  getConfigContent(): string {
+    return this._content;
+  }
+
+  getConfigFileName(): string {
+    return this._fileName;
+  }
+
+  getIndent(): string {
+    return this._indent;
+  }
+}
+
+export class MigratedDataFactory {
+  // singleton
+  private static _data: MigratedData;
+
+  public static async getAsync(config_: RenovateConfig): Promise<MigratedData> {
+    if (this._data) {
+      return this._data;
+    }
+    const d = await this.build(config_);
+    this._data = new MigratedData(d?.content, d?.fileName, d?.indent);
+    return this._data;
+  }
+
+  public static reset(): void {
+    this._data = null;
+  }
+
+  // istanbul ignore next: unused constructor for a static factory class
+  private constructor() {
+    return;
+  }
+
+  private static async build(
+    config_: RenovateConfig
+  ): Promise<IMigratedData | null> {
+    let res: IMigratedData;
+    try {
+      const config = { ...config_ };
+      const rc = await detectRepoFileConfig();
+      const configFileParsed = rc?.configFileParsed || {};
+
+      // get migrated config
+      const migrated = await migrateAndValidate(config, configFileParsed);
+      delete migrated.errors;
+      delete migrated.warnings;
+
+      const raw = await readLocalFile(rc.configFileName, 'utf8');
+
+      // indent defaults to 2 spaces
+      const indent = detectIndent(raw).indent ?? '  ';
+      const fileName = rc.configFileName;
+      let content = JSON.stringify(migrated, undefined, indent);
+      if (!content.endsWith('\n')) {
+        content += '\n';
+      }
+
+      res = { content, fileName, indent };
+    } catch (err) {
+      logger.debug(
+        err,
+        'MigratedDataFactory.getAsync() Error initializing renovate MigratedData'
+      );
+    }
+    return res;
+  }
+}
+
+interface IMigratedData {
+  content: string;
+  fileName: string;
+  indent: string;
+}

lib/workers/repository/config-migration/branch/rebase.ts

@@ -0,0 +1,62 @@
+import { GlobalConfig } from '../../../../config/global';
+import type { RenovateConfig } from '../../../../config/types';
+import { logger } from '../../../../logger';
+import { commitAndPush } from '../../../../modules/platform/commit';
+import {
+  getFile,
+  isBranchModified,
+  isBranchStale,
+  setGitAuthor,
+} from '../../../../util/git';
+import { ConfigMigrationCommitMessageFactory } from './commit-message';
+import type { MigratedData } from './migrated-data';
+
+export async function rebaseMigrationBranch(
+  config: RenovateConfig,
+  migratedConfigData: MigratedData
+): Promise<string | null> {
+  logger.debug('Checking if onboarding branch needs rebasing');
+  if (await isBranchModified(config.configMigrationBranch)) {
+    logger.debug('Onboarding branch has been edited and cannot be rebased');
+    return null;
+  }
+  const configFileName = migratedConfigData.getConfigFileName();
+  const contents = migratedConfigData.getConfigContent();
+  const existingContents = await getFile(
+    configFileName,
+    config.configMigrationBranch
+  );
+  if (
+    contents === existingContents &&
+    !(await isBranchStale(config.configMigrationBranch))
+  ) {
+    logger.debug('Migration branch is up to date');
+    return null;
+  }
+  logger.debug('Rebasing migration branch');
+
+  const commitMessageFactory = new ConfigMigrationCommitMessageFactory(
+    config,
+    configFileName
+  );
+  const commitMessage = commitMessageFactory.create();
+
+  if (GlobalConfig.get('dryRun')) {
+    logger.info('DRY-RUN: Would rebase files in migration branch');
+    return null;
+  }
+
+  setGitAuthor(config.gitAuthor);
+  return commitAndPush({
+    branchName: config.configMigrationBranch,
+    files: [
+      {
+        type: 'addition',
+        path: configFileName,
+        contents,
+      },
+    ],
+    message: commitMessage.toString(),
+    platformCommit: !!config.platformCommit,
+  });
+}

lib/workers/repository/config-migration/pr/errors-warnings.ts

@@ -0,0 +1,28 @@
+import type { RenovateConfig } from '../../../../config/types';
+
+export function getWarnings(config: RenovateConfig): string {
+  if (!config?.warnings?.length) {
+    return '';
+  }
+  let warningText = `\n# Warnings (${config?.warnings.length})\n\n`;
+  warningText += `Please correct - or verify that you can safely ignore - these warnings before you merge this PR.\n\n`;
+  config?.warnings.forEach((w) => {
+    warningText += `-   \`${w.topic}\`: ${w.message}\n`;
+  });
+  warningText += '\n---\n';
+  return warningText;
+}
+
+export function getErrors(config: RenovateConfig): string {
+  let errorText = '';
+  if (!config?.errors?.length) {
+    return '';
+  }
+  errorText = `\n# Errors (${config?.errors.length})\n\n`;
+  errorText += `Renovate has found errors that you should fix (in this branch) before finishing this PR.\n\n`;
+  config?.errors.forEach((e) => {
+    errorText += `-   \`${e.topic}\`: ${e.message}\n`;
+  });
+  errorText += '\n---\n';
+  return errorText;
+}