renovate 44.198.2 → 44.199.0

package/dist/workers/repository/config-migration/pr/index.js

@@ -1,17 +1,13 @@
 import { GlobalConfig } from "../../../../config/global.js";
 import { logger } from "../../../../logger/index.js";
 import { joinUrlParts } from "../../../../util/url.js";
-import { compile } from "../../../../util/template/index.js";
 import { emojify } from "../../../../util/emoji.js";
-import { hashBody } from "../../../../modules/platform/pr-body.js";
-import { scm } from "../../../../modules/platform/scm.js";
 import { platform } from "../../../../modules/platform/index.js";
 import { getMigrationBranchName } from "../common.js";
 import { ConfigMigrationCommitMessageFactory } from "../branch/commit-message.js";
-import { prepareLabels } from "../../update/pr/labels.js";
-import { addParticipants } from "../../update/pr/participants.js";
-import { getPlatformPrOptions } from "../../update/pr/index.js";
-import { isString } from "@sindresorhus/is";
+import { getPrFooter } from "../../update/pr/body/footer.js";
+import { getPrHeader } from "../../update/pr/body/header.js";
+import { ensureConfigPr } from "../../update/pr/ensure-config-pr.js";
 //#region lib/workers/repository/config-migration/pr/index.ts
 async function ensureConfigMigrationPr(config, migratedConfigData) {
 	logger.debug("ensureConfigMigrationPr()");
@@ -31,57 +27,16 @@ ${filename.endsWith(".json5") ? `#### [PLEASE NOTE](${docsLink}): JSON5 config f
 :no_bell: **Ignore**: Close this PR and you won't be reminded about config migration again, but one day your current config may no longer be valid.
 
 :question: Got questions? Does something look wrong to you? Please don't hesitate to [request help here](${GlobalConfig.get("productLinks").help}).\n\n`);
-	if (isString(config.prHeader)) prBody = `${compile(config.prHeader, config)}\n\n${prBody}`;
-	if (isString(config.prFooter)) prBody = `${prBody}\n---\n\n${compile(config.prFooter, config)}\n`;
-	logger.trace({ prBody }, "prBody");
-	prBody = platform.massageMarkdown(prBody, config.rebaseLabel);
-	if (existingPr) {
-		logger.debug("Found open migration PR");
-		const prBodyHash = hashBody(prBody);
-		if (existingPr.bodyStruct?.hash === prBodyHash && existingPr.title === prTitle) {
-			logger.debug(`Pr does not need updating, PrNo: ${existingPr.number}`);
-			return existingPr;
-		}
-		if (GlobalConfig.get("dryRun")) logger.info("DRY-RUN: Would update migration PR");
-		else {
-			await platform.updatePr({
-				number: existingPr.number,
-				prTitle,
-				prBody
-			});
-			logger.info({ pr: existingPr.number }, "Migration PR updated");
-		}
-		return existingPr;
-	}
-	logger.debug("Creating migration PR");
-	const labels = prepareLabels(config);
-	try {
-		if (GlobalConfig.get("dryRun")) logger.info("DRY-RUN: Would create migration PR");
-		else {
-			const pr = await platform.createPr({
-				sourceBranch: branchName,
-				targetBranch: config.defaultBranch,
-				prTitle,
-				prBody,
-				labels,
-				platformPrOptions: getPlatformPrOptions({
-					...config,
-					automerge: false
-				})
-			});
-			logger.info({ pr: pr?.number }, "Migration PR created");
-			if (pr) await addParticipants(config, pr);
-			return pr;
-		}
-	} catch (err) {
-		if (err.response?.statusCode === 422 && err.response?.body?.errors?.[0]?.message?.startsWith("A pull request already exists")) {
-			logger.warn({ err }, "Migration PR already exists but cannot find it. It was probably created by a different user.");
-			await scm.deleteBranch(branchName);
-			return null;
-		}
-		throw err;
-	}
-	return null;
+	prBody = `${getPrHeader(config)}${prBody}${getPrFooter(config)}`;
+	return await ensureConfigPr({
+		branchName,
+		targetBranch: config.defaultBranch,
+		prTitle,
+		prBody,
+		config,
+		existingPr,
+		type: "migration"
+	});
 }
 //#endregion
 export { ensureConfigMigrationPr };

package/dist/workers/repository/config-migration/pr/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","names":["template.compile"],"sources":["../../../../../lib/workers/repository/config-migration/pr/index.ts"],"sourcesContent":["import { isString } from '@sindresorhus/is';\nimport { GlobalConfig } from '../../../../config/global.ts';\nimport type { RenovateConfig } from '../../../../config/types.ts';\nimport { logger } from '../../../../logger/index.ts';\nimport type { Pr } from '../../../../modules/platform/index.ts';\nimport { platform } from '../../../../modules/platform/index.ts';\nimport { hashBody } from '../../../../modules/platform/pr-body.ts';\nimport { scm } from '../../../../modules/platform/scm.ts';\nimport { emojify } from '../../../../util/emoji.ts';\nimport * as template from '../../../../util/template/index.ts';\nimport { joinUrlParts } from '../../../../util/url.ts';\nimport { getPlatformPrOptions } from '../../update/pr/index.ts';\nimport { prepareLabels } from '../../update/pr/labels.ts';\nimport { addParticipants } from '../../update/pr/participants.ts';\nimport { ConfigMigrationCommitMessageFactory } from '../branch/commit-message.ts';\nimport type { MigratedData } from '../branch/migrated-data.ts';\nimport { getMigrationBranchName } from '../common.ts';\n\nexport async function ensureConfigMigrationPr(\n  config: RenovateConfig,\n  migratedConfigData: MigratedData,\n): Promise<Pr | null> {\n  logger.debug('ensureConfigMigrationPr()');\n  const docsLink = joinUrlParts(\n    GlobalConfig.get('productLinks').documentation,\n    'configuration-options/#configmigration',\n  );\n  const branchName = getMigrationBranchName(config);\n  const commitMessageFactory = new ConfigMigrationCommitMessageFactory(\n    config,\n    migratedConfigData.filename,\n  );\n\n  const prTitle = commitMessageFactory.getPrTitle();\n  const existingPr = await platform.getBranchPr(branchName, config.baseBranch);\n  const filename = migratedConfigData.filename;\n  logger.debug('Filling in config migration PR template');\n  let prBody = `The Renovate config in this repository needs migrating. Typically this is because one or more configuration options you are using have been renamed.\n\n  You don't need to merge this PR right away, because Renovate will continue to migrate these fields internally each time it runs. But later some of these fields may be fully deprecated and the migrations removed. So it's a good idea to merge this migration PR soon. \\n\\n`;\n  prBody += emojify(\n    `\n\n${\n  filename.endsWith('.json5')\n    ? `#### [PLEASE NOTE](${docsLink}): ` +\n      `JSON5 config file migrated! All comments & trailing commas were removed.`\n    : ''\n}\n\n:no_bell: **Ignore**: Close this PR and you won't be reminded about config migration again, but one day your current config may no longer be valid.\n\n:question: Got questions? Does something look wrong to you? Please don't hesitate to [request help here](${\n      GlobalConfig.get('productLinks').help\n    }).\\n\\n`,\n  );\n\n  if (isString(config.prHeader)) {\n    prBody = `${template.compile(config.prHeader, config)}\\n\\n${prBody}`;\n  }\n  if (isString(config.prFooter)) {\n    prBody = `${prBody}\\n---\\n\\n${template.compile(config.prFooter, config)}\\n`;\n  }\n  logger.trace({ prBody }, 'prBody');\n\n  prBody = platform.massageMarkdown(prBody, config.rebaseLabel);\n\n  if (existingPr) {\n    logger.debug('Found open migration PR');\n    // Check if existing PR needs updating\n    const prBodyHash = hashBody(prBody);\n    if (\n      existingPr.bodyStruct?.hash === prBodyHash &&\n      existingPr.title === prTitle\n    ) {\n      logger.debug(`Pr does not need updating, PrNo: ${existingPr.number}`);\n      return existingPr;\n    }\n    // PR must need updating\n    if (GlobalConfig.get('dryRun')) {\n      logger.info('DRY-RUN: Would update migration PR');\n    } else {\n      await platform.updatePr({\n        number: existingPr.number,\n        prTitle,\n        prBody,\n      });\n      logger.info({ pr: existingPr.number }, 'Migration PR updated');\n    }\n    return existingPr;\n  }\n  logger.debug('Creating migration PR');\n  const labels = prepareLabels(config);\n  try {\n    if (GlobalConfig.get('dryRun')) {\n      logger.info('DRY-RUN: Would create migration PR');\n    } else {\n      const pr = await platform.createPr({\n        sourceBranch: branchName,\n        // TODO #22198\n        targetBranch: config.defaultBranch!,\n        prTitle,\n        prBody,\n        labels,\n        platformPrOptions: getPlatformPrOptions({\n          ...config,\n          automerge: false,\n        }),\n      });\n      logger.info({ pr: pr?.number }, 'Migration PR created');\n      if (pr) {\n        await addParticipants(config, pr);\n      }\n\n      return pr;\n    }\n  } catch (err) {\n    if (\n      err.response?.statusCode === 422 &&\n      err.response?.body?.errors?.[0]?.message?.startsWith(\n        'A pull request already exists',\n      )\n    ) {\n      logger.warn(\n        { err },\n        'Migration PR already exists but cannot find it. It was probably created by a different user.',\n      );\n      await scm.deleteBranch(branchName);\n      return null;\n    }\n    throw err;\n  }\n\n  return null;\n}\n"],"mappings":";;;;;;;;;;;;;;;AAkBA,eAAsB,wBACpB,QACA,oBACoB;CACpB,OAAO,MAAM,2BAA2B;CACxC,MAAM,WAAW,aACf,aAAa,IAAI,cAAc,CAAC,CAAC,eACjC,wCACF;CACA,MAAM,aAAa,uBAAuB,MAAM;CAMhD,MAAM,UAAU,IALiB,oCAC/B,QACA,mBAAmB,QAGc,CAAC,CAAC,WAAW;CAChD,MAAM,aAAa,MAAM,SAAS,YAAY,YAAY,OAAO,UAAU;CAC3E,MAAM,WAAW,mBAAmB;CACpC,OAAO,MAAM,yCAAyC;CACtD,IAAI,SAAS;;;CAGb,UAAU,QACR;;EAGF,SAAS,SAAS,QAAQ,IACtB,sBAAsB,SAAS,+EAE/B,GACL;;;;2GAKK,aAAa,IAAI,cAAc,CAAC,CAAC,KAClC,OACH;CAEA,IAAI,SAAS,OAAO,QAAQ,GAC1B,SAAS,GAAGA,QAAiB,OAAO,UAAU,MAAM,EAAE,MAAM;CAE9D,IAAI,SAAS,OAAO,QAAQ,GAC1B,SAAS,GAAG,OAAO,WAAWA,QAAiB,OAAO,UAAU,MAAM,EAAE;CAE1E,OAAO,MAAM,EAAE,OAAO,GAAG,QAAQ;CAEjC,SAAS,SAAS,gBAAgB,QAAQ,OAAO,WAAW;CAE5D,IAAI,YAAY;EACd,OAAO,MAAM,yBAAyB;EAEtC,MAAM,aAAa,SAAS,MAAM;EAClC,IACE,WAAW,YAAY,SAAS,cAChC,WAAW,UAAU,SACrB;GACA,OAAO,MAAM,oCAAoC,WAAW,QAAQ;GACpE,OAAO;EACT;EAEA,IAAI,aAAa,IAAI,QAAQ,GAC3B,OAAO,KAAK,oCAAoC;OAC3C;GACL,MAAM,SAAS,SAAS;IACtB,QAAQ,WAAW;IACnB;IACA;GACF,CAAC;GACD,OAAO,KAAK,EAAE,IAAI,WAAW,OAAO,GAAG,sBAAsB;EAC/D;EACA,OAAO;CACT;CACA,OAAO,MAAM,uBAAuB;CACpC,MAAM,SAAS,cAAc,MAAM;CACnC,IAAI;EACF,IAAI,aAAa,IAAI,QAAQ,GAC3B,OAAO,KAAK,oCAAoC;OAC3C;GACL,MAAM,KAAK,MAAM,SAAS,SAAS;IACjC,cAAc;IAEd,cAAc,OAAO;IACrB;IACA;IACA;IACA,mBAAmB,qBAAqB;KACtC,GAAG;KACH,WAAW;IACb,CAAC;GACH,CAAC;GACD,OAAO,KAAK,EAAE,IAAI,IAAI,OAAO,GAAG,sBAAsB;GACtD,IAAI,IACF,MAAM,gBAAgB,QAAQ,EAAE;GAGlC,OAAO;EACT;CACF,SAAS,KAAK;EACZ,IACE,IAAI,UAAU,eAAe,OAC7B,IAAI,UAAU,MAAM,SAAS,EAAE,EAAE,SAAS,WACxC,+BACF,GACA;GACA,OAAO,KACL,EAAE,IAAI,GACN,8FACF;GACA,MAAM,IAAI,aAAa,UAAU;GACjC,OAAO;EACT;EACA,MAAM;CACR;CAEA,OAAO;AACT"}
+{"version":3,"file":"index.js","names":[],"sources":["../../../../../lib/workers/repository/config-migration/pr/index.ts"],"sourcesContent":["import { GlobalConfig } from '../../../../config/global.ts';\nimport type { RenovateConfig } from '../../../../config/types.ts';\nimport { logger } from '../../../../logger/index.ts';\nimport type { Pr } from '../../../../modules/platform/index.ts';\nimport { platform } from '../../../../modules/platform/index.ts';\nimport { emojify } from '../../../../util/emoji.ts';\nimport { joinUrlParts } from '../../../../util/url.ts';\nimport { getPrFooter } from '../../update/pr/body/footer.ts';\nimport { getPrHeader } from '../../update/pr/body/header.ts';\nimport { ensureConfigPr } from '../../update/pr/ensure-config-pr.ts';\nimport { ConfigMigrationCommitMessageFactory } from '../branch/commit-message.ts';\nimport type { MigratedData } from '../branch/migrated-data.ts';\nimport { getMigrationBranchName } from '../common.ts';\n\nexport async function ensureConfigMigrationPr(\n  config: RenovateConfig,\n  migratedConfigData: MigratedData,\n): Promise<Pr | null> {\n  logger.debug('ensureConfigMigrationPr()');\n  const docsLink = joinUrlParts(\n    GlobalConfig.get('productLinks').documentation,\n    'configuration-options/#configmigration',\n  );\n  const branchName = getMigrationBranchName(config);\n  const commitMessageFactory = new ConfigMigrationCommitMessageFactory(\n    config,\n    migratedConfigData.filename,\n  );\n\n  const prTitle = commitMessageFactory.getPrTitle();\n  const existingPr = await platform.getBranchPr(branchName, config.baseBranch);\n  const filename = migratedConfigData.filename;\n  logger.debug('Filling in config migration PR template');\n  let prBody = `The Renovate config in this repository needs migrating. Typically this is because one or more configuration options you are using have been renamed.\n\n  You don't need to merge this PR right away, because Renovate will continue to migrate these fields internally each time it runs. But later some of these fields may be fully deprecated and the migrations removed. So it's a good idea to merge this migration PR soon. \\n\\n`;\n  prBody += emojify(\n    `\n\n${\n  filename.endsWith('.json5')\n    ? `#### [PLEASE NOTE](${docsLink}): ` +\n      `JSON5 config file migrated! All comments & trailing commas were removed.`\n    : ''\n}\n\n:no_bell: **Ignore**: Close this PR and you won't be reminded about config migration again, but one day your current config may no longer be valid.\n\n:question: Got questions? Does something look wrong to you? Please don't hesitate to [request help here](${\n      GlobalConfig.get('productLinks').help\n    }).\\n\\n`,\n  );\n\n  prBody = `${getPrHeader(config)}${prBody}${getPrFooter(config)}`;\n\n  return await ensureConfigPr({\n    branchName,\n    // TODO #22198\n    targetBranch: config.defaultBranch!,\n    prTitle,\n    prBody,\n    config,\n    existingPr,\n    type: 'migration',\n  });\n}\n"],"mappings":";;;;;;;;;;;AAcA,eAAsB,wBACpB,QACA,oBACoB;CACpB,OAAO,MAAM,2BAA2B;CACxC,MAAM,WAAW,aACf,aAAa,IAAI,cAAc,CAAC,CAAC,eACjC,wCACF;CACA,MAAM,aAAa,uBAAuB,MAAM;CAMhD,MAAM,UAAU,IALiB,oCAC/B,QACA,mBAAmB,QAGc,CAAC,CAAC,WAAW;CAChD,MAAM,aAAa,MAAM,SAAS,YAAY,YAAY,OAAO,UAAU;CAC3E,MAAM,WAAW,mBAAmB;CACpC,OAAO,MAAM,yCAAyC;CACtD,IAAI,SAAS;;;CAGb,UAAU,QACR;;EAGF,SAAS,SAAS,QAAQ,IACtB,sBAAsB,SAAS,+EAE/B,GACL;;;;2GAKK,aAAa,IAAI,cAAc,CAAC,CAAC,KAClC,OACH;CAEA,SAAS,GAAG,YAAY,MAAM,IAAI,SAAS,YAAY,MAAM;CAE7D,OAAO,MAAM,eAAe;EAC1B;EAEA,cAAc,OAAO;EACrB;EACA;EACA;EACA;EACA,MAAM;CACR,CAAC;AACH"}

package/dist/workers/repository/model/commit-body.js

@@ -0,0 +1,27 @@
+import { logger } from "../../../logger/index.js";
+import { withoutUrlCredentials } from "../../../util/url.js";
+import { compile } from "../../../util/template/index.js";
+import { filterValidCommitTrailers } from "../../../util/git/commit-trailers.js";
+//#region lib/workers/repository/model/commit-body.ts
+/**
+* Appends the compiled `commitBody` to `message`, without URL credentials, or returns `message` unchanged when no `commitBody` is configured.
+*/
+function compileCommitBody(config, message, context) {
+	if (!config.commitBody) return message;
+	const compiledMessage = `${message}\n\n${withoutUrlCredentials(compile(config.commitBody, context))}`;
+	logger.trace(`commitMessage: ${JSON.stringify(compiledMessage)}`);
+	return compiledMessage;
+}
+/**
+* Compiles `commitTrailers` without URL credentials and drops the ones that are invalid after compilation, or returns `undefined` when none are configured.
+*/
+function compileCommitTrailers(config, context) {
+	if (!config.commitTrailers) return;
+	const trailers = filterValidCommitTrailers(config.commitTrailers.map((trailer) => withoutUrlCredentials(compile(trailer, context))));
+	logger.trace(`commitTrailers: ${JSON.stringify(trailers)}`);
+	return trailers;
+}
+//#endregion
+export { compileCommitBody, compileCommitTrailers };
+
+//# sourceMappingURL=commit-body.js.map

package/dist/workers/repository/model/commit-body.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"commit-body.js","names":[],"sources":["../../../../lib/workers/repository/model/commit-body.ts"],"sourcesContent":["import type { RenovateConfig } from '../../../config/types.ts';\nimport { logger } from '../../../logger/index.ts';\nimport { filterValidCommitTrailers } from '../../../util/git/commit-trailers.ts';\nimport { compile } from '../../../util/template/index.ts';\nimport { withoutUrlCredentials } from '../../../util/url.ts';\n\n/**\n * Appends the compiled `commitBody` to `message`, without URL credentials, or returns `message` unchanged when no `commitBody` is configured.\n */\nexport function compileCommitBody(\n  config: Pick<RenovateConfig, 'commitBody'>,\n  message: string,\n  context: object,\n): string {\n  if (!config.commitBody) {\n    return message;\n  }\n\n  const compiledMessage = `${message}\\n\\n${withoutUrlCredentials(compile(config.commitBody, context))}`;\n  logger.trace(`commitMessage: ${JSON.stringify(compiledMessage)}`);\n  return compiledMessage;\n}\n\n/**\n * Compiles `commitTrailers` without URL credentials and drops the ones that are invalid after compilation, or returns `undefined` when none are configured.\n */\nexport function compileCommitTrailers(\n  config: Pick<RenovateConfig, 'commitTrailers'>,\n  context: object,\n): string[] | undefined {\n  if (!config.commitTrailers) {\n    return undefined;\n  }\n\n  // Template expansions can produce broken trailers\n  const trailers = filterValidCommitTrailers(\n    config.commitTrailers.map((trailer) =>\n      withoutUrlCredentials(compile(trailer, context)),\n    ),\n  );\n  logger.trace(`commitTrailers: ${JSON.stringify(trailers)}`);\n  return trailers;\n}\n"],"mappings":";;;;;;;;AASA,SAAgB,kBACd,QACA,SACA,SACQ;CACR,IAAI,CAAC,OAAO,YACV,OAAO;CAGT,MAAM,kBAAkB,GAAG,QAAQ,MAAM,sBAAsB,QAAQ,OAAO,YAAY,OAAO,CAAC;CAClG,OAAO,MAAM,kBAAkB,KAAK,UAAU,eAAe,GAAG;CAChE,OAAO;AACT;;;;AAKA,SAAgB,sBACd,QACA,SACsB;CACtB,IAAI,CAAC,OAAO,gBACV;CAIF,MAAM,WAAW,0BACf,OAAO,eAAe,KAAK,YACzB,sBAAsB,QAAQ,SAAS,OAAO,CAAC,CACjD,CACF;CACA,OAAO,MAAM,mBAAmB,KAAK,UAAU,QAAQ,GAAG;CAC1D,OAAO;AACT"}

package/dist/workers/repository/model/commit-config-file.js

@@ -0,0 +1,40 @@
+import { GlobalConfig } from "../../../config/global.js";
+import { logger } from "../../../logger/index.js";
+import { scm } from "../../../modules/platform/scm.js";
+import { compileCommitBody, compileCommitTrailers } from "./commit-body.js";
+import { CommitMessageFactory } from "./commit-message-factory.js";
+//#region lib/workers/repository/model/commit-config-file.ts
+/**
+* Builds the commit message for a commit which writes a Renovate config file: the shared prefix and semantic commit handling of `CommitMessageFactory`, with a subject supplied by the caller.
+*/
+function createConfigFileCommitMessage(config, subject) {
+	const commitMessage = new CommitMessageFactory(config).create();
+	commitMessage.subject = subject;
+	return commitMessage.toString();
+}
+/**
+* Commits a Renovate config file to its branch, shared by onboarding and config migration.
+*/
+async function commitConfigFile({ config, branchName, getFiles, message, prTitle, force, dryRunMessage }) {
+	if (GlobalConfig.get("dryRun")) {
+		logger.info(dryRunMessage);
+		return null;
+	}
+	const templateContext = { gitAuthor: config.gitAuthor };
+	const commitMessage = compileCommitBody(config, message, templateContext);
+	const trailers = compileCommitTrailers(config, templateContext);
+	return await scm.commitAndPush({
+		baseBranch: config.baseBranch,
+		branchName,
+		files: await getFiles(),
+		message: commitMessage,
+		trailers,
+		platformCommit: config.platformCommit,
+		force,
+		prTitle
+	});
+}
+//#endregion
+export { commitConfigFile, createConfigFileCommitMessage };
+
+//# sourceMappingURL=commit-config-file.js.map

package/dist/workers/repository/model/commit-config-file.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"commit-config-file.js","names":[],"sources":["../../../../lib/workers/repository/model/commit-config-file.ts"],"sourcesContent":["import { GlobalConfig } from '../../../config/global.ts';\nimport type { RenovateConfig } from '../../../config/types.ts';\nimport { logger } from '../../../logger/index.ts';\nimport { scm } from '../../../modules/platform/scm.ts';\nimport type { FileChange } from '../../../util/git/types.ts';\nimport { compileCommitBody, compileCommitTrailers } from './commit-body.ts';\nimport type { CommitMessageConfig } from './commit-message-factory.ts';\nimport { CommitMessageFactory } from './commit-message-factory.ts';\n\n/**\n * Builds the commit message for a commit which writes a Renovate config file: the shared prefix and semantic commit handling of `CommitMessageFactory`, with a subject supplied by the caller.\n */\nexport function createConfigFileCommitMessage(\n  config: CommitMessageConfig,\n  subject: string,\n): string {\n  const commitMessageFactory = new CommitMessageFactory(config);\n  const commitMessage = commitMessageFactory.create();\n  commitMessage.subject = subject;\n  return commitMessage.toString();\n}\n\nexport interface CommitConfigFileConfig {\n  /** Supplies `baseBranch`, `platformCommit`, `commitBody`, `commitTrailers` and `gitAuthor` */\n  config: Partial<RenovateConfig>;\n  branchName: string;\n  /** Called after the dry run check */\n  getFiles: () => FileChange[] | Promise<FileChange[]>;\n  message: string;\n  /** Only needed by Gerrit platform */\n  prTitle: string;\n  force?: boolean;\n  /** Logged instead of committing when `dryRun` is enabled */\n  dryRunMessage: string;\n}\n\n/**\n * Commits a Renovate config file to its branch, shared by onboarding and config migration.\n */\nexport async function commitConfigFile({\n  config,\n  branchName,\n  getFiles,\n  message,\n  prTitle,\n  force,\n  dryRunMessage,\n}: CommitConfigFileConfig): Promise<string | null> {\n  if (GlobalConfig.get('dryRun')) {\n    logger.info(dryRunMessage);\n    return null;\n  }\n\n  // only allow the gitAuthor template value in the commitBody and commitTrailers\n  const templateContext = { gitAuthor: config.gitAuthor };\n  const commitMessage = compileCommitBody(config, message, templateContext);\n  const trailers = compileCommitTrailers(config, templateContext);\n\n  return await scm.commitAndPush({\n    baseBranch: config.baseBranch,\n    branchName,\n    files: await getFiles(),\n    message: commitMessage,\n    trailers,\n    platformCommit: config.platformCommit,\n    force,\n    // Only needed by Gerrit platform\n    prTitle,\n  });\n}\n"],"mappings":";;;;;;;;;AAYA,SAAgB,8BACd,QACA,SACQ;CAER,MAAM,gBAAgB,IADW,qBAAqB,MACb,CAAC,CAAC,OAAO;CAClD,cAAc,UAAU;CACxB,OAAO,cAAc,SAAS;AAChC;;;;AAmBA,eAAsB,iBAAiB,EACrC,QACA,YACA,UACA,SACA,SACA,OACA,iBACiD;CACjD,IAAI,aAAa,IAAI,QAAQ,GAAG;EAC9B,OAAO,KAAK,aAAa;EACzB,OAAO;CACT;CAGA,MAAM,kBAAkB,EAAE,WAAW,OAAO,UAAU;CACtD,MAAM,gBAAgB,kBAAkB,QAAQ,SAAS,eAAe;CACxE,MAAM,WAAW,sBAAsB,QAAQ,eAAe;CAE9D,OAAO,MAAM,IAAI,cAAc;EAC7B,YAAY,OAAO;EACnB;EACA,OAAO,MAAM,SAAS;EACtB,SAAS;EACT;EACA,gBAAgB,OAAO;EACvB;EAEA;CACF,CAAC;AACH"}

package/dist/workers/repository/model/commit-message-factory.js.map

@@ -1 +1 @@
-{"version":3,"file":"commit-message-factory.js","names":[],"sources":["../../../../lib/workers/repository/model/commit-message-factory.ts"],"sourcesContent":["import type { RenovateSharedConfig } from '../../../config/types.ts';\nimport { coerceString } from '../../../util/string.ts';\nimport type { CommitMessage } from './commit-message.ts';\nimport { CustomCommitMessage } from './custom-commit-message.ts';\nimport { SemanticCommitMessage } from './semantic-commit-message.ts';\n\ntype CommitMessageConfig = Pick<\n  RenovateSharedConfig,\n  | 'commitMessagePrefix'\n  | 'semanticCommits'\n  | 'semanticCommitScope'\n  | 'semanticCommitType'\n>;\n\nexport class CommitMessageFactory {\n  private readonly _config: CommitMessageConfig;\n\n  constructor(config: CommitMessageConfig) {\n    this._config = config;\n  }\n\n  create(): CommitMessage {\n    const message = this.areSemanticCommitsEnabled\n      ? this.createSemanticCommitMessage()\n      : this.createCustomCommitMessage();\n\n    return message;\n  }\n\n  private createSemanticCommitMessage(): SemanticCommitMessage {\n    const message = new SemanticCommitMessage();\n\n    message.type = coerceString(this._config.semanticCommitType);\n    message.scope = coerceString(this._config.semanticCommitScope);\n\n    return message;\n  }\n\n  private createCustomCommitMessage(): CustomCommitMessage {\n    const message = new CustomCommitMessage();\n    message.prefix = this._config.commitMessagePrefix ?? '';\n\n    return message;\n  }\n\n  private get areSemanticCommitsEnabled(): boolean {\n    return (\n      !this._config.commitMessagePrefix &&\n      this._config.semanticCommits === 'enabled'\n    );\n  }\n}\n"],"mappings":";;;;AAcA,IAAa,uBAAb,MAAkC;CAChC;CAEA,YAAY,QAA6B;EACvC,KAAK,UAAU;CACjB;CAEA,SAAwB;EAKtB,OAJgB,KAAK,4BACjB,KAAK,4BAA4B,IACjC,KAAK,0BAA0B;CAGrC;CAEA,8BAA6D;EAC3D,MAAM,UAAU,IAAI,sBAAsB;EAE1C,QAAQ,OAAO,aAAa,KAAK,QAAQ,kBAAkB;EAC3D,QAAQ,QAAQ,aAAa,KAAK,QAAQ,mBAAmB;EAE7D,OAAO;CACT;CAEA,4BAAyD;EACvD,MAAM,UAAU,IAAI,oBAAoB;EACxC,QAAQ,SAAS,KAAK,QAAQ,uBAAuB;EAErD,OAAO;CACT;CAEA,IAAY,4BAAqC;EAC/C,OACE,CAAC,KAAK,QAAQ,uBACd,KAAK,QAAQ,oBAAoB;CAErC;AACF"}
+{"version":3,"file":"commit-message-factory.js","names":[],"sources":["../../../../lib/workers/repository/model/commit-message-factory.ts"],"sourcesContent":["import type { RenovateSharedConfig } from '../../../config/types.ts';\nimport { coerceString } from '../../../util/string.ts';\nimport type { CommitMessage } from './commit-message.ts';\nimport { CustomCommitMessage } from './custom-commit-message.ts';\nimport { SemanticCommitMessage } from './semantic-commit-message.ts';\n\nexport type CommitMessageConfig = Pick<\n  RenovateSharedConfig,\n  | 'commitMessagePrefix'\n  | 'semanticCommits'\n  | 'semanticCommitScope'\n  | 'semanticCommitType'\n>;\n\nexport class CommitMessageFactory {\n  private readonly _config: CommitMessageConfig;\n\n  constructor(config: CommitMessageConfig) {\n    this._config = config;\n  }\n\n  create(): CommitMessage {\n    const message = this.areSemanticCommitsEnabled\n      ? this.createSemanticCommitMessage()\n      : this.createCustomCommitMessage();\n\n    return message;\n  }\n\n  private createSemanticCommitMessage(): SemanticCommitMessage {\n    const message = new SemanticCommitMessage();\n\n    message.type = coerceString(this._config.semanticCommitType);\n    message.scope = coerceString(this._config.semanticCommitScope);\n\n    return message;\n  }\n\n  private createCustomCommitMessage(): CustomCommitMessage {\n    const message = new CustomCommitMessage();\n    message.prefix = this._config.commitMessagePrefix ?? '';\n\n    return message;\n  }\n\n  private get areSemanticCommitsEnabled(): boolean {\n    return (\n      !this._config.commitMessagePrefix &&\n      this._config.semanticCommits === 'enabled'\n    );\n  }\n}\n"],"mappings":";;;;AAcA,IAAa,uBAAb,MAAkC;CAChC;CAEA,YAAY,QAA6B;EACvC,KAAK,UAAU;CACjB;CAEA,SAAwB;EAKtB,OAJgB,KAAK,4BACjB,KAAK,4BAA4B,IACjC,KAAK,0BAA0B;CAGrC;CAEA,8BAA6D;EAC3D,MAAM,UAAU,IAAI,sBAAsB;EAE1C,QAAQ,OAAO,aAAa,KAAK,QAAQ,kBAAkB;EAC3D,QAAQ,QAAQ,aAAa,KAAK,QAAQ,mBAAmB;EAE7D,OAAO;CACT;CAEA,4BAAyD;EACvD,MAAM,UAAU,IAAI,oBAAoB;EACxC,QAAQ,SAAS,KAAK,QAAQ,uBAAuB;EAErD,OAAO;CACT;CAEA,IAAY,4BAAqC;EAC/C,OACE,CAAC,KAAK,QAAQ,uBACd,KAAK,QAAQ,oBAAoB;CAErC;AACF"}

package/dist/workers/repository/onboarding/branch/commit-message.js

@@ -1,22 +1,13 @@
 import { getInheritedOrGlobal } from "../../../../util/common.js";
-import { CommitMessageFactory } from "../../model/commit-message-factory.js";
+import { createConfigFileCommitMessage } from "../../model/commit-config-file.js";
+import { isNonEmptyString } from "@sindresorhus/is";
 //#region lib/workers/repository/onboarding/branch/commit-message.ts
-var OnboardingCommitMessageFactory = class {
-	config;
-	configFile;
-	constructor(config, configFile) {
-		this.config = config;
-		this.configFile = configFile;
-	}
-	create() {
-		const onboardingCommitMessage = getInheritedOrGlobal("onboardingCommitMessage");
-		const commitMessage = new CommitMessageFactory(this.config).create();
-		if (onboardingCommitMessage) commitMessage.subject = onboardingCommitMessage;
-		else commitMessage.subject = `add ${this.configFile}`;
-		return commitMessage;
-	}
-};
+function getOnboardingCommitMessage(config, configFile) {
+	const onboardingCommitMessage = getInheritedOrGlobal("onboardingCommitMessage");
+	const subject = isNonEmptyString(onboardingCommitMessage) ? onboardingCommitMessage : `add ${configFile}`;
+	return createConfigFileCommitMessage(config, subject);
+}
 //#endregion
-export { OnboardingCommitMessageFactory };
+export { getOnboardingCommitMessage };
 
 //# sourceMappingURL=commit-message.js.map

package/dist/workers/repository/onboarding/branch/commit-message.js.map

@@ -1 +1 @@
-{"version":3,"file":"commit-message.js","names":[],"sources":["../../../../../lib/workers/repository/onboarding/branch/commit-message.ts"],"sourcesContent":["import type { RenovateConfig } from '../../../../config/types.ts';\nimport { getInheritedOrGlobal } from '../../../../util/common.ts';\nimport type { CommitMessage } from '../../model/commit-message.ts';\nimport { CommitMessageFactory } from '../../model/commit-message-factory.ts';\n\nexport class OnboardingCommitMessageFactory {\n  private readonly config: RenovateConfig;\n\n  private readonly configFile: string;\n\n  constructor(config: RenovateConfig, configFile: string) {\n    this.config = config;\n    this.configFile = configFile;\n  }\n\n  create(): CommitMessage {\n    const onboardingCommitMessage = getInheritedOrGlobal(\n      'onboardingCommitMessage',\n    );\n    const commitMessageFactory = new CommitMessageFactory(this.config);\n    const commitMessage = commitMessageFactory.create();\n\n    if (onboardingCommitMessage) {\n      commitMessage.subject = onboardingCommitMessage;\n    } else {\n      commitMessage.subject = `add ${this.configFile}`;\n    }\n\n    return commitMessage;\n  }\n}\n"],"mappings":";;;AAKA,IAAa,iCAAb,MAA4C;CAC1C;CAEA;CAEA,YAAY,QAAwB,YAAoB;EACtD,KAAK,SAAS;EACd,KAAK,aAAa;CACpB;CAEA,SAAwB;EACtB,MAAM,0BAA0B,qBAC9B,yBACF;EAEA,MAAM,gBAAgB,IADW,qBAAqB,KAAK,MAClB,CAAC,CAAC,OAAO;EAElD,IAAI,yBACF,cAAc,UAAU;OAExB,cAAc,UAAU,OAAO,KAAK;EAGtC,OAAO;CACT;AACF"}
+{"version":3,"file":"commit-message.js","names":[],"sources":["../../../../../lib/workers/repository/onboarding/branch/commit-message.ts"],"sourcesContent":["import { isNonEmptyString } from '@sindresorhus/is';\nimport type { RenovateConfig } from '../../../../config/types.ts';\nimport { getInheritedOrGlobal } from '../../../../util/common.ts';\nimport { createConfigFileCommitMessage } from '../../model/commit-config-file.ts';\n\nexport function getOnboardingCommitMessage(\n  config: RenovateConfig,\n  configFile: string,\n): string {\n  const onboardingCommitMessage = getInheritedOrGlobal(\n    'onboardingCommitMessage',\n  );\n  const subject = isNonEmptyString(onboardingCommitMessage)\n    ? onboardingCommitMessage\n    : `add ${configFile}`;\n\n  return createConfigFileCommitMessage(config, subject);\n}\n"],"mappings":";;;;AAKA,SAAgB,2BACd,QACA,YACQ;CACR,MAAM,0BAA0B,qBAC9B,yBACF;CACA,MAAM,UAAU,iBAAiB,uBAAuB,IACpD,0BACA,OAAO;CAEX,OAAO,8BAA8B,QAAQ,OAAO;AACtD"}

package/dist/workers/repository/onboarding/branch/create.js

@@ -1,45 +1,27 @@
-import { GlobalConfig } from "../../../../config/global.js";
-import { coerceArray } from "../../../../util/array.js";
 import { logger } from "../../../../logger/index.js";
 import { getInheritedOrGlobal } from "../../../../util/common.js";
-import { compile } from "../../../../util/template/index.js";
-import { filterValidCommitTrailers } from "../../../../util/git/commit-trailers.js";
-import { scm } from "../../../../modules/platform/scm.js";
+import { commitConfigFile } from "../../model/commit-config-file.js";
 import { getOnboardingConfigContents } from "./config.js";
-import { getDefaultConfigFileName, getSemanticCommitPrTitle } from "../common.js";
-import { OnboardingCommitMessageFactory } from "./commit-message.js";
+import { getDefaultConfigFileName, getOnboardingPrTitle } from "../common.js";
+import { getOnboardingCommitMessage } from "./commit-message.js";
 //#region lib/workers/repository/onboarding/branch/create.ts
 async function createOnboardingBranch(config) {
 	logger.debug("createOnboardingBranch()");
 	const configFile = getDefaultConfigFileName();
 	const contents = await getOnboardingConfigContents(config, configFile);
 	logger.debug("Creating onboarding branch");
-	let commitMessage = new OnboardingCommitMessageFactory(config, configFile).create().toString();
-	if (config.commitBody) {
-		commitMessage = `${commitMessage}\n\n${compile(config.commitBody, { gitAuthor: config.gitAuthor })}`;
-		logger.trace(`commitMessage: ${commitMessage}`);
-	}
-	const compiledTrailers = coerceArray(config.commitTrailers).map((trailer) => compile(trailer, { gitAuthor: config.gitAuthor }));
-	const trailers = filterValidCommitTrailers(compiledTrailers);
-	// istanbul ignore if
-	if (GlobalConfig.get("dryRun")) {
-		logger.info("DRY-RUN: Would commit files to onboarding branch");
-		return null;
-	}
-	const prTitle = config.semanticCommits === "enabled" ? getSemanticCommitPrTitle(config) : getInheritedOrGlobal("onboardingPrTitle");
-	return scm.commitAndPush({
-		baseBranch: config.baseBranch,
+	return await commitConfigFile({
+		config,
 		branchName: getInheritedOrGlobal("onboardingBranch"),
-		files: [{
+		getFiles: () => [{
 			type: "addition",
 			path: configFile,
 			contents
 		}],
-		message: commitMessage,
-		trailers,
-		platformCommit: config.platformCommit,
+		message: getOnboardingCommitMessage(config, configFile),
+		prTitle: getOnboardingPrTitle(config),
 		force: true,
-		prTitle
+		dryRunMessage: "DRY-RUN: Would commit files to onboarding branch"
 	});
 }
 //#endregion

package/dist/workers/repository/onboarding/branch/create.js.map

@@ -1 +1 @@
-{"version":3,"file":"create.js","names":[],"sources":["../../../../../lib/workers/repository/onboarding/branch/create.ts"],"sourcesContent":["import { GlobalConfig } from '../../../../config/global.ts';\nimport type { RenovateConfig } from '../../../../config/types.ts';\nimport { logger } from '../../../../logger/index.ts';\nimport { scm } from '../../../../modules/platform/scm.ts';\nimport { coerceArray } from '../../../../util/array.ts';\nimport { getInheritedOrGlobal } from '../../../../util/common.ts';\nimport { filterValidCommitTrailers } from '../../../../util/git/commit-trailers.ts';\nimport { compile } from '../../../../util/template/index.ts';\nimport {\n  getDefaultConfigFileName,\n  getSemanticCommitPrTitle,\n} from '../common.ts';\nimport { OnboardingCommitMessageFactory } from './commit-message.ts';\nimport { getOnboardingConfigContents } from './config.ts';\n\nexport async function createOnboardingBranch(\n  config: Partial<RenovateConfig>,\n): Promise<string | null> {\n  logger.debug('createOnboardingBranch()');\n  const configFile = getDefaultConfigFileName();\n  // TODO #22198\n  const contents = await getOnboardingConfigContents(config, configFile);\n  logger.debug('Creating onboarding branch');\n\n  const commitMessageFactory = new OnboardingCommitMessageFactory(\n    config,\n    configFile,\n  );\n  let commitMessage = commitMessageFactory.create().toString();\n\n  if (config.commitBody) {\n    commitMessage = `${commitMessage}\\n\\n${compile(\n      config.commitBody,\n      // only allow gitAuthor template value in the commitBody\n      { gitAuthor: config.gitAuthor },\n    )}`;\n\n    logger.trace(`commitMessage: ${commitMessage}`);\n  }\n\n  // only allow gitAuthor template value in the commitTrailers\n  const compiledTrailers = coerceArray(config.commitTrailers).map((trailer) =>\n    compile(trailer, { gitAuthor: config.gitAuthor }),\n  );\n  const trailers = filterValidCommitTrailers(compiledTrailers);\n\n  // istanbul ignore if\n  if (GlobalConfig.get('dryRun')) {\n    logger.info('DRY-RUN: Would commit files to onboarding branch');\n    return null;\n  }\n\n  const prTitle =\n    config.semanticCommits === 'enabled'\n      ? getSemanticCommitPrTitle(config)\n      : getInheritedOrGlobal('onboardingPrTitle')!;\n\n  return scm.commitAndPush({\n    baseBranch: config.baseBranch,\n    branchName: getInheritedOrGlobal('onboardingBranch')!,\n    files: [\n      {\n        type: 'addition',\n        // TODO #22198\n        path: configFile,\n        contents,\n      },\n    ],\n    message: commitMessage,\n    trailers,\n    platformCommit: config.platformCommit,\n    force: true,\n    // Only needed by Gerrit platform\n    prTitle,\n  });\n}\n"],"mappings":";;;;;;;;;;;AAeA,eAAsB,uBACpB,QACwB;CACxB,OAAO,MAAM,0BAA0B;CACvC,MAAM,aAAa,yBAAyB;CAE5C,MAAM,WAAW,MAAM,4BAA4B,QAAQ,UAAU;CACrE,OAAO,MAAM,4BAA4B;CAMzC,IAAI,gBAAgB,IAJa,+BAC/B,QACA,UAEqC,CAAC,CAAC,OAAO,CAAC,CAAC,SAAS;CAE3D,IAAI,OAAO,YAAY;EACrB,gBAAgB,GAAG,cAAc,MAAM,QACrC,OAAO,YAEP,EAAE,WAAW,OAAO,UAAU,CAChC;EAEA,OAAO,MAAM,kBAAkB,eAAe;CAChD;CAGA,MAAM,mBAAmB,YAAY,OAAO,cAAc,CAAC,CAAC,KAAK,YAC/D,QAAQ,SAAS,EAAE,WAAW,OAAO,UAAU,CAAC,CAClD;CACA,MAAM,WAAW,0BAA0B,gBAAgB;;CAG3D,IAAI,aAAa,IAAI,QAAQ,GAAG;EAC9B,OAAO,KAAK,kDAAkD;EAC9D,OAAO;CACT;CAEA,MAAM,UACJ,OAAO,oBAAoB,YACvB,yBAAyB,MAAM,IAC/B,qBAAqB,mBAAmB;CAE9C,OAAO,IAAI,cAAc;EACvB,YAAY,OAAO;EACnB,YAAY,qBAAqB,kBAAkB;EACnD,OAAO,CACL;GACE,MAAM;GAEN,MAAM;GACN;EACF,CACF;EACA,SAAS;EACT;EACA,gBAAgB,OAAO;EACvB,OAAO;EAEP;CACF,CAAC;AACH"}
+{"version":3,"file":"create.js","names":[],"sources":["../../../../../lib/workers/repository/onboarding/branch/create.ts"],"sourcesContent":["import type { RenovateConfig } from '../../../../config/types.ts';\nimport { logger } from '../../../../logger/index.ts';\nimport { getInheritedOrGlobal } from '../../../../util/common.ts';\nimport { commitConfigFile } from '../../model/commit-config-file.ts';\nimport { getDefaultConfigFileName, getOnboardingPrTitle } from '../common.ts';\nimport { getOnboardingCommitMessage } from './commit-message.ts';\nimport { getOnboardingConfigContents } from './config.ts';\n\nexport async function createOnboardingBranch(\n  config: Partial<RenovateConfig>,\n): Promise<string | null> {\n  logger.debug('createOnboardingBranch()');\n  const configFile = getDefaultConfigFileName();\n  // TODO #22198\n  const contents = await getOnboardingConfigContents(config, configFile);\n  logger.debug('Creating onboarding branch');\n\n  return await commitConfigFile({\n    config,\n    branchName: getInheritedOrGlobal('onboardingBranch')!,\n    // TODO #22198\n    getFiles: () => [{ type: 'addition', path: configFile, contents }],\n    message: getOnboardingCommitMessage(config, configFile),\n    prTitle: getOnboardingPrTitle(config),\n    force: true,\n    dryRunMessage: 'DRY-RUN: Would commit files to onboarding branch',\n  });\n}\n"],"mappings":";;;;;;;AAQA,eAAsB,uBACpB,QACwB;CACxB,OAAO,MAAM,0BAA0B;CACvC,MAAM,aAAa,yBAAyB;CAE5C,MAAM,WAAW,MAAM,4BAA4B,QAAQ,UAAU;CACrE,OAAO,MAAM,4BAA4B;CAEzC,OAAO,MAAM,iBAAiB;EAC5B;EACA,YAAY,qBAAqB,kBAAkB;EAEnD,gBAAgB,CAAC;GAAE,MAAM;GAAY,MAAM;GAAY;EAAS,CAAC;EACjE,SAAS,2BAA2B,QAAQ,UAAU;EACtD,SAAS,qBAAqB,MAAM;EACpC,OAAO;EACP,eAAe;CACjB,CAAC;AACH"}

package/dist/workers/repository/onboarding/branch/rebase.js

@@ -2,10 +2,10 @@ import { GlobalConfig } from "../../../../config/global.js";
 import { logger } from "../../../../logger/index.js";
 import { toSha256 } from "../../../../util/hash.js";
 import { getInheritedOrGlobal } from "../../../../util/common.js";
-import { scm } from "../../../../modules/platform/scm.js";
+import { commitConfigFile } from "../../model/commit-config-file.js";
 import { getOnboardingConfigContents } from "./config.js";
-import { getDefaultConfigFileName, getSemanticCommitPrTitle } from "../common.js";
-import { OnboardingCommitMessageFactory } from "./commit-message.js";
+import { getDefaultConfigFileName, getOnboardingPrTitle } from "../common.js";
+import { getOnboardingCommitMessage } from "./commit-message.js";
 //#region lib/workers/repository/onboarding/branch/rebase.ts
 async function rebaseOnboardingBranch(config, previousConfigHash) {
 	logger.debug("Checking if onboarding branch needs rebasing");
@@ -30,23 +30,17 @@ async function rebaseOnboardingBranch(config, previousConfigHash) {
 		previousConfigHash,
 		currentConfigHash
 	}, "Rebasing onboarding branch");
-	if (GlobalConfig.get("dryRun")) {
-		logger.info("DRY-RUN: Would rebase files in onboarding branch");
-		return null;
-	}
-	const commitMessage = new OnboardingCommitMessageFactory(config, configFile).create();
-	const prTitle = config.semanticCommits === "enabled" ? getSemanticCommitPrTitle(config) : getInheritedOrGlobal("onboardingPrTitle");
-	return scm.commitAndPush({
-		baseBranch: config.baseBranch,
+	return await commitConfigFile({
+		config,
 		branchName: getInheritedOrGlobal("onboardingBranch"),
-		files: [{
+		getFiles: () => [{
 			type: "addition",
 			path: configFile,
 			contents
 		}],
-		message: commitMessage.toString(),
-		platformCommit: config.platformCommit,
-		prTitle
+		message: getOnboardingCommitMessage(config, configFile),
+		prTitle: getOnboardingPrTitle(config),
+		dryRunMessage: "DRY-RUN: Would rebase files in onboarding branch"
 	});
 }
 //#endregion

package/dist/workers/repository/onboarding/branch/rebase.js.map

@@ -1 +1 @@
-{"version":3,"file":"rebase.js","names":[],"sources":["../../../../../lib/workers/repository/onboarding/branch/rebase.ts"],"sourcesContent":["import { GlobalConfig } from '../../../../config/global.ts';\nimport type { RenovateConfig } from '../../../../config/types.ts';\nimport { logger } from '../../../../logger/index.ts';\nimport { scm } from '../../../../modules/platform/scm.ts';\nimport { getInheritedOrGlobal } from '../../../../util/common.ts';\nimport { toSha256 } from '../../../../util/hash.ts';\nimport {\n  getDefaultConfigFileName,\n  getSemanticCommitPrTitle,\n} from '../common.ts';\nimport { OnboardingCommitMessageFactory } from './commit-message.ts';\nimport { getOnboardingConfigContents } from './config.ts';\n\nexport async function rebaseOnboardingBranch(\n  config: RenovateConfig,\n  previousConfigHash: string | undefined,\n): Promise<string | null> {\n  logger.debug('Checking if onboarding branch needs rebasing');\n\n  // skip platforms that do not support html comments in pr\n  const platform = GlobalConfig.get('platform');\n  if (!['github', 'gitea', 'gitlab', 'forgejo'].includes(platform)) {\n    logger.debug(\n      `Skipping rebase as ${platform} does not support html comments`,\n    );\n    return null;\n  }\n\n  const configFile = getDefaultConfigFileName();\n  const contents = await getOnboardingConfigContents(config, configFile);\n  const currentConfigHash = toSha256(contents);\n\n  if (previousConfigHash === currentConfigHash) {\n    logger.debug('No rebase needed');\n    return null;\n  }\n  logger.debug(\n    { previousConfigHash, currentConfigHash },\n    'Rebasing onboarding branch',\n  );\n\n  if (GlobalConfig.get('dryRun')) {\n    logger.info('DRY-RUN: Would rebase files in onboarding branch');\n    return null;\n  }\n\n  const commitMessageFactory = new OnboardingCommitMessageFactory(\n    config,\n    configFile,\n  );\n  const commitMessage = commitMessageFactory.create();\n\n  const prTitle =\n    config.semanticCommits === 'enabled'\n      ? getSemanticCommitPrTitle(config)\n      : getInheritedOrGlobal('onboardingPrTitle')!;\n\n  // TODO #22198\n  return scm.commitAndPush({\n    baseBranch: config.baseBranch,\n    branchName: getInheritedOrGlobal('onboardingBranch')!,\n    files: [\n      {\n        type: 'addition',\n        path: configFile,\n        contents,\n      },\n    ],\n    message: commitMessage.toString(),\n    platformCommit: config.platformCommit,\n    // Only needed by Gerrit platform\n    prTitle,\n  });\n}\n"],"mappings":";;;;;;;;;AAaA,eAAsB,uBACpB,QACA,oBACwB;CACxB,OAAO,MAAM,8CAA8C;CAG3D,MAAM,WAAW,aAAa,IAAI,UAAU;CAC5C,IAAI,CAAC;EAAC;EAAU;EAAS;EAAU;CAAS,CAAC,CAAC,SAAS,QAAQ,GAAG;EAChE,OAAO,MACL,sBAAsB,SAAS,gCACjC;EACA,OAAO;CACT;CAEA,MAAM,aAAa,yBAAyB;CAC5C,MAAM,WAAW,MAAM,4BAA4B,QAAQ,UAAU;CACrE,MAAM,oBAAoB,SAAS,QAAQ;CAE3C,IAAI,uBAAuB,mBAAmB;EAC5C,OAAO,MAAM,kBAAkB;EAC/B,OAAO;CACT;CACA,OAAO,MACL;EAAE;EAAoB;CAAkB,GACxC,4BACF;CAEA,IAAI,aAAa,IAAI,QAAQ,GAAG;EAC9B,OAAO,KAAK,kDAAkD;EAC9D,OAAO;CACT;CAMA,MAAM,gBAAgB,IAJW,+BAC/B,QACA,UAEuC,CAAC,CAAC,OAAO;CAElD,MAAM,UACJ,OAAO,oBAAoB,YACvB,yBAAyB,MAAM,IAC/B,qBAAqB,mBAAmB;CAG9C,OAAO,IAAI,cAAc;EACvB,YAAY,OAAO;EACnB,YAAY,qBAAqB,kBAAkB;EACnD,OAAO,CACL;GACE,MAAM;GACN,MAAM;GACN;EACF,CACF;EACA,SAAS,cAAc,SAAS;EAChC,gBAAgB,OAAO;EAEvB;CACF,CAAC;AACH"}
+{"version":3,"file":"rebase.js","names":[],"sources":["../../../../../lib/workers/repository/onboarding/branch/rebase.ts"],"sourcesContent":["import { GlobalConfig } from '../../../../config/global.ts';\nimport type { RenovateConfig } from '../../../../config/types.ts';\nimport { logger } from '../../../../logger/index.ts';\nimport { getInheritedOrGlobal } from '../../../../util/common.ts';\nimport { toSha256 } from '../../../../util/hash.ts';\nimport { commitConfigFile } from '../../model/commit-config-file.ts';\nimport { getDefaultConfigFileName, getOnboardingPrTitle } from '../common.ts';\nimport { getOnboardingCommitMessage } from './commit-message.ts';\nimport { getOnboardingConfigContents } from './config.ts';\n\nexport async function rebaseOnboardingBranch(\n  config: RenovateConfig,\n  previousConfigHash: string | undefined,\n): Promise<string | null> {\n  logger.debug('Checking if onboarding branch needs rebasing');\n\n  // skip platforms that do not support html comments in pr\n  const platform = GlobalConfig.get('platform');\n  if (!['github', 'gitea', 'gitlab', 'forgejo'].includes(platform)) {\n    logger.debug(\n      `Skipping rebase as ${platform} does not support html comments`,\n    );\n    return null;\n  }\n\n  const configFile = getDefaultConfigFileName();\n  const contents = await getOnboardingConfigContents(config, configFile);\n  const currentConfigHash = toSha256(contents);\n\n  if (previousConfigHash === currentConfigHash) {\n    logger.debug('No rebase needed');\n    return null;\n  }\n  logger.debug(\n    { previousConfigHash, currentConfigHash },\n    'Rebasing onboarding branch',\n  );\n\n  return await commitConfigFile({\n    config,\n    branchName: getInheritedOrGlobal('onboardingBranch')!,\n    // TODO #22198\n    getFiles: () => [{ type: 'addition', path: configFile, contents }],\n    message: getOnboardingCommitMessage(config, configFile),\n    prTitle: getOnboardingPrTitle(config),\n    dryRunMessage: 'DRY-RUN: Would rebase files in onboarding branch',\n  });\n}\n"],"mappings":";;;;;;;;;AAUA,eAAsB,uBACpB,QACA,oBACwB;CACxB,OAAO,MAAM,8CAA8C;CAG3D,MAAM,WAAW,aAAa,IAAI,UAAU;CAC5C,IAAI,CAAC;EAAC;EAAU;EAAS;EAAU;CAAS,CAAC,CAAC,SAAS,QAAQ,GAAG;EAChE,OAAO,MACL,sBAAsB,SAAS,gCACjC;EACA,OAAO;CACT;CAEA,MAAM,aAAa,yBAAyB;CAC5C,MAAM,WAAW,MAAM,4BAA4B,QAAQ,UAAU;CACrE,MAAM,oBAAoB,SAAS,QAAQ;CAE3C,IAAI,uBAAuB,mBAAmB;EAC5C,OAAO,MAAM,kBAAkB;EAC/B,OAAO;CACT;CACA,OAAO,MACL;EAAE;EAAoB;CAAkB,GACxC,4BACF;CAEA,OAAO,MAAM,iBAAiB;EAC5B;EACA,YAAY,qBAAqB,kBAAkB;EAEnD,gBAAgB,CAAC;GAAE,MAAM;GAAY,MAAM;GAAY;EAAS,CAAC;EACjE,SAAS,2BAA2B,QAAQ,UAAU;EACtD,SAAS,qBAAqB,MAAM;EACpC,eAAe;CACjB,CAAC;AACH"}

package/dist/workers/repository/onboarding/common.js

@@ -6,6 +6,10 @@ import { getInheritedOrGlobal } from "../../../util/common.js";
 function getSemanticCommitPrTitle(config) {
 	return `${config.semanticCommitType ?? "chore"}: ${getInheritedOrGlobal("onboardingPrTitle")}`;
 }
+function getOnboardingPrTitle(config) {
+	if (config.semanticCommits === "enabled") return getSemanticCommitPrTitle(config);
+	return getInheritedOrGlobal("onboardingPrTitle");
+}
 function getDefaultConfigFileName() {
 	const configFileNames = getConfigFileNames();
 	const onboardingConfigFileName = getInheritedOrGlobal("onboardingConfigFileName");
@@ -34,6 +38,6 @@ var OnboardingState = class OnboardingState {
 	}
 };
 //#endregion
-export { OnboardingState, getDefaultConfigFileName, getSemanticCommitPrTitle };
+export { OnboardingState, getDefaultConfigFileName, getOnboardingPrTitle, getSemanticCommitPrTitle };
 
 //# sourceMappingURL=common.js.map

package/dist/workers/repository/onboarding/common.js.map

@@ -1 +1 @@
-{"version":3,"file":"common.js","names":["memCache.get"],"sources":["../../../../lib/workers/repository/onboarding/common.ts"],"sourcesContent":["import { getConfigFileNames } from '../../../config/app-strings.ts';\nimport type { RenovateConfig } from '../../../config/types.ts';\nimport { logger } from '../../../logger/index.ts';\nimport * as memCache from '../../../util/cache/memory/index.ts';\nimport { getInheritedOrGlobal } from '../../../util/common.ts';\n\nexport function getSemanticCommitPrTitle(config: RenovateConfig): string {\n  return `${config.semanticCommitType ?? 'chore'}: ${getInheritedOrGlobal('onboardingPrTitle')}`;\n}\n\nexport function getDefaultConfigFileName(): string {\n  const configFileNames = getConfigFileNames();\n  const onboardingConfigFileName = getInheritedOrGlobal(\n    'onboardingConfigFileName',\n  );\n  return configFileNames.includes(onboardingConfigFileName!)\n    ? onboardingConfigFileName!\n    : configFileNames[0];\n}\n\nexport class OnboardingState {\n  private static readonly cacheKey = 'OnboardingState';\n  private static readonly skipKey = 'OnboardingStateValid';\n\n  static get prUpdateRequested(): boolean {\n    const updateRequested = !!memCache.get<boolean | undefined>(\n      OnboardingState.cacheKey,\n    );\n    logger.trace(\n      { value: updateRequested },\n      'Get OnboardingState.prUpdateRequested',\n    );\n    return updateRequested;\n  }\n\n  static set prUpdateRequested(value: boolean) {\n    logger.trace({ value }, 'Set OnboardingState.prUpdateRequested');\n    memCache.set(OnboardingState.cacheKey, value);\n  }\n\n  static get onboardingCacheValid(): boolean {\n    const cacheValid = !!memCache.get<boolean | undefined>(\n      OnboardingState.skipKey,\n    );\n    logger.trace(\n      { value: cacheValid },\n      'Get OnboardingState.onboardingCacheValid',\n    );\n    return cacheValid;\n  }\n\n  static set onboardingCacheValid(value: boolean) {\n    logger.trace({ value }, 'Set OnboardingState.onboardingCacheValid');\n    memCache.set(OnboardingState.skipKey, value);\n  }\n}\n"],"mappings":";;;;;AAMA,SAAgB,yBAAyB,QAAgC;CACvE,OAAO,GAAG,OAAO,sBAAsB,QAAQ,IAAI,qBAAqB,mBAAmB;AAC7F;AAEA,SAAgB,2BAAmC;CACjD,MAAM,kBAAkB,mBAAmB;CAC3C,MAAM,2BAA2B,qBAC/B,0BACF;CACA,OAAO,gBAAgB,SAAS,wBAAyB,IACrD,2BACA,gBAAgB;AACtB;AAEA,IAAa,kBAAb,MAAa,gBAAgB;CAC3B,OAAwB,WAAW;CACnC,OAAwB,UAAU;CAElC,WAAW,oBAA6B;EACtC,MAAM,kBAAkB,CAAC,CAACA,IACxB,gBAAgB,QAClB;EACA,OAAO,MACL,EAAE,OAAO,gBAAgB,GACzB,uCACF;EACA,OAAO;CACT;CAEA,WAAW,kBAAkB,OAAgB;EAC3C,OAAO,MAAM,EAAE,MAAM,GAAG,uCAAuC;EAC/D,IAAa,gBAAgB,UAAU,KAAK;CAC9C;CAEA,WAAW,uBAAgC;EACzC,MAAM,aAAa,CAAC,CAACA,IACnB,gBAAgB,OAClB;EACA,OAAO,MACL,EAAE,OAAO,WAAW,GACpB,0CACF;EACA,OAAO;CACT;CAEA,WAAW,qBAAqB,OAAgB;EAC9C,OAAO,MAAM,EAAE,MAAM,GAAG,0CAA0C;EAClE,IAAa,gBAAgB,SAAS,KAAK;CAC7C;AACF"}
+{"version":3,"file":"common.js","names":["memCache.get"],"sources":["../../../../lib/workers/repository/onboarding/common.ts"],"sourcesContent":["import { getConfigFileNames } from '../../../config/app-strings.ts';\nimport type { RenovateConfig } from '../../../config/types.ts';\nimport { logger } from '../../../logger/index.ts';\nimport * as memCache from '../../../util/cache/memory/index.ts';\nimport { getInheritedOrGlobal } from '../../../util/common.ts';\n\nexport function getSemanticCommitPrTitle(config: RenovateConfig): string {\n  return `${config.semanticCommitType ?? 'chore'}: ${getInheritedOrGlobal('onboardingPrTitle')}`;\n}\n\nexport function getOnboardingPrTitle(config: RenovateConfig): string {\n  if (config.semanticCommits === 'enabled') {\n    return getSemanticCommitPrTitle(config);\n  }\n  // TODO #22198\n  return getInheritedOrGlobal('onboardingPrTitle')!;\n}\n\nexport function getDefaultConfigFileName(): string {\n  const configFileNames = getConfigFileNames();\n  const onboardingConfigFileName = getInheritedOrGlobal(\n    'onboardingConfigFileName',\n  );\n  return configFileNames.includes(onboardingConfigFileName!)\n    ? onboardingConfigFileName!\n    : configFileNames[0];\n}\n\nexport class OnboardingState {\n  private static readonly cacheKey = 'OnboardingState';\n  private static readonly skipKey = 'OnboardingStateValid';\n\n  static get prUpdateRequested(): boolean {\n    const updateRequested = !!memCache.get<boolean | undefined>(\n      OnboardingState.cacheKey,\n    );\n    logger.trace(\n      { value: updateRequested },\n      'Get OnboardingState.prUpdateRequested',\n    );\n    return updateRequested;\n  }\n\n  static set prUpdateRequested(value: boolean) {\n    logger.trace({ value }, 'Set OnboardingState.prUpdateRequested');\n    memCache.set(OnboardingState.cacheKey, value);\n  }\n\n  static get onboardingCacheValid(): boolean {\n    const cacheValid = !!memCache.get<boolean | undefined>(\n      OnboardingState.skipKey,\n    );\n    logger.trace(\n      { value: cacheValid },\n      'Get OnboardingState.onboardingCacheValid',\n    );\n    return cacheValid;\n  }\n\n  static set onboardingCacheValid(value: boolean) {\n    logger.trace({ value }, 'Set OnboardingState.onboardingCacheValid');\n    memCache.set(OnboardingState.skipKey, value);\n  }\n}\n"],"mappings":";;;;;AAMA,SAAgB,yBAAyB,QAAgC;CACvE,OAAO,GAAG,OAAO,sBAAsB,QAAQ,IAAI,qBAAqB,mBAAmB;AAC7F;AAEA,SAAgB,qBAAqB,QAAgC;CACnE,IAAI,OAAO,oBAAoB,WAC7B,OAAO,yBAAyB,MAAM;CAGxC,OAAO,qBAAqB,mBAAmB;AACjD;AAEA,SAAgB,2BAAmC;CACjD,MAAM,kBAAkB,mBAAmB;CAC3C,MAAM,2BAA2B,qBAC/B,0BACF;CACA,OAAO,gBAAgB,SAAS,wBAAyB,IACrD,2BACA,gBAAgB;AACtB;AAEA,IAAa,kBAAb,MAAa,gBAAgB;CAC3B,OAAwB,WAAW;CACnC,OAAwB,UAAU;CAElC,WAAW,oBAA6B;EACtC,MAAM,kBAAkB,CAAC,CAACA,IACxB,gBAAgB,QAClB;EACA,OAAO,MACL,EAAE,OAAO,gBAAgB,GACzB,uCACF;EACA,OAAO;CACT;CAEA,WAAW,kBAAkB,OAAgB;EAC3C,OAAO,MAAM,EAAE,MAAM,GAAG,uCAAuC;EAC/D,IAAa,gBAAgB,UAAU,KAAK;CAC9C;CAEA,WAAW,uBAAgC;EACzC,MAAM,aAAa,CAAC,CAACA,IACnB,gBAAgB,OAClB;EACA,OAAO,MACL,EAAE,OAAO,WAAW,GACpB,0CACF;EACA,OAAO;CACT;CAEA,WAAW,qBAAqB,OAAgB;EAC9C,OAAO,MAAM,EAAE,MAAM,GAAG,0CAA0C;EAClE,IAAa,gBAAgB,SAAS,KAAK;CAC7C;AACF"}

package/dist/workers/repository/onboarding/pr/index.js

@@ -3,25 +3,23 @@ import { GlobalConfig } from "../../../../config/global.js";
 import { logger } from "../../../../logger/index.js";
 import { toSha256 } from "../../../../util/hash.js";
 import { getInheritedOrGlobal } from "../../../../util/common.js";
-import { compile } from "../../../../util/template/index.js";
 import { getFile } from "../../../../util/git/index.js";
 import { getElapsedDays } from "../../../../util/date.js";
 import { emojify } from "../../../../util/emoji.js";
-import { hashBody } from "../../../../modules/platform/pr-body.js";
-import { scm } from "../../../../modules/platform/scm.js";
 import { platform } from "../../../../modules/platform/index.js";
 import { isOnboardingBranchConflicted } from "../branch/onboarding-branch-cache.js";
-import { OnboardingState, getDefaultConfigFileName, getSemanticCommitPrTitle } from "../common.js";
+import { OnboardingState, getDefaultConfigFileName, getOnboardingPrTitle } from "../common.js";
+import { getPrFooter } from "../../update/pr/body/footer.js";
+import { getPrHeader } from "../../update/pr/body/header.js";
 import { ensureComment } from "../../../../modules/platform/comment.js";
 import { getDepWarningsOnboardingPR, getErrors, getWarnings } from "../../errors-warnings.js";
-import { prepareLabels } from "../../update/pr/labels.js";
-import { addParticipants } from "../../update/pr/participants.js";
-import { getPlatformPrOptions } from "../../update/pr/index.js";
+import { getRebaseCheckbox } from "../../update/pr/body/controls.js";
+import { ensureConfigPr } from "../../update/pr/ensure-config-pr.js";
 import { getBaseBranchDesc } from "./base-branch.js";
 import { getConfigDesc } from "./config-description.js";
 import { getPackageFilesDesc, getPackageFilesSummary } from "./package-files.js";
 import { getExpectedPrList, getExpectedPrListSummary } from "./pr-list.js";
-import { isNumber, isString } from "@sindresorhus/is";
+import { isNumber } from "@sindresorhus/is";
 //#region lib/workers/repository/onboarding/pr/index.ts
 /**
 * Given an existing PR, if onboardingAutoCloseAge has passed, close the PR.
@@ -109,10 +107,7 @@ function fillOnboardingPrBody(prTemplate, sections) {
 	return prBody;
 }
 function finalizeOnboardingPrBody(prBody, config, onboardingConfigHashComment) {
-	let finalPrBody = prBody;
-	if (isString(config.prHeader)) finalPrBody = `${compile(config.prHeader, config)}\n\n${finalPrBody}`;
-	if (isString(config.prFooter)) finalPrBody = `${finalPrBody}\n---\n\n${compile(config.prFooter, config)}\n`;
-	return finalPrBody + onboardingConfigHashComment;
+	return `${getPrHeader(config)}${prBody}${getPrFooter(config)}${onboardingConfigHashComment}`;
 }
 async function ensureOnboardingPr(config, packageFiles, branches) {
 	if (config.onboardingRebaseCheckbox && !OnboardingState.prUpdateRequested) return "onboarding";
@@ -171,61 +166,17 @@ async function ensureOnboardingPr(config, packageFiles, branches) {
 			}), config, onboardingConfigHashComment);
 		} else prBody = prBody.replace(prList, prListSummary);
 	}
-	logger.trace(`prBody:\n${prBody}`);
-	prBody = platform.massageMarkdown(prBody, config.rebaseLabel);
-	if (existingPr) {
-		logger.debug("Found open onboarding PR");
-		const prBodyHash = hashBody(prBody);
-		if (existingPr.bodyStruct?.hash === prBodyHash) {
-			logger.debug(`Pull Request #${existingPr.number} does not need updating`);
-			return "onboarding";
-		}
-		if (GlobalConfig.get("dryRun")) logger.info("DRY-RUN: Would update onboarding PR");
-		else {
-			await platform.updatePr({
-				number: existingPr.number,
-				prTitle: existingPr.title,
-				prBody
-			});
-			logger.info({ pr: existingPr.number }, "Onboarding PR updated");
-		}
-		return "onboarding";
-	}
-	logger.debug("Creating onboarding PR");
-	const labels = prepareLabels(config);
-	try {
-		if (GlobalConfig.get("dryRun")) logger.info("DRY-RUN: Would create onboarding PR");
-		else {
-			const prTitle = config.semanticCommits === "enabled" ? getSemanticCommitPrTitle(config) : getInheritedOrGlobal("onboardingPrTitle");
-			const pr = await platform.createPr({
-				sourceBranch: onboardingBranch,
-				targetBranch: config.defaultBranch,
-				prTitle,
-				prBody,
-				labels,
-				platformPrOptions: getPlatformPrOptions({
-					...config,
-					automerge: false
-				})
-			});
-			logger.info({ pr: `Pull Request #${pr.number}` }, "Onboarding PR created");
-			await addParticipants(config, pr);
-		}
-	} catch (err) {
-		if (err.response?.statusCode === 422 && err.response?.body?.errors?.[0]?.message?.startsWith("A pull request already exists")) {
-			logger.warn("Onboarding PR already exists but cannot find it. It was probably created by a different user.");
-			await scm.deleteBranch(onboardingBranch);
-			return "onboarding";
-		}
-		throw err;
-	}
+	await ensureConfigPr({
+		branchName: onboardingBranch,
+		targetBranch: config.defaultBranch,
+		prTitle: existingPr?.title ?? getOnboardingPrTitle(config),
+		prBody,
+		config,
+		existingPr,
+		type: "onboarding"
+	});
 	return "onboarding";
 }
-function getRebaseCheckbox(onboardingRebaseCheckbox) {
-	let rebaseCheckBox = "";
-	if (onboardingRebaseCheckbox) rebaseCheckBox = `\n\n---\n\n - [ ] <!-- rebase-check -->If you want to rebase/retry this PR, click this checkbox.\n`;
-	return rebaseCheckBox;
-}
 async function getOnboardingConfigHashComment() {
 	const configFile = getDefaultConfigFileName();
 	const existingContents = await getFile(configFile, getInheritedOrGlobal("onboardingBranch")) ?? "";