feat(git): allow commit-and-push to different target branch (#19680)

lib/util/git/index.ts

@@ -52,6 +52,7 @@ import type {
   CommitResult,
   CommitSha,
   LocalConfig,
+  PushFilesConfig,
   StatusResult,
   StorageConfig,
   TreeItem,
@@ -1029,11 +1030,12 @@ export async function prepareCommit({
 }
 
 export async function pushCommit({
-  branchName,
+  sourceRef,
+  targetRef,
   files,
-}: CommitFilesConfig): Promise<boolean> {
+}: PushFilesConfig): Promise<boolean> {
   await syncGit();
-  logger.debug(`Pushing branch ${branchName}`);
+  logger.debug(`Pushing refSpec ${sourceRef}:${targetRef ?? sourceRef}`);
   let result = false;
   try {
     const pushOptions: TaskOptions = {
@@ -1045,14 +1047,14 @@ export async function pushCommit({
     }
 
     const pushRes = await gitRetry(() =>
-      git.push('origin', `${branchName}:${branchName}`, pushOptions)
+      git.push('origin', `${sourceRef}:${targetRef ?? sourceRef}`, pushOptions)
     );
     delete pushRes.repo;
     logger.debug({ result: pushRes }, 'git push');
     incLimitedValue('Commits');
     result = true;
   } catch (err) /* istanbul ignore next */ {
-    handleCommitError(files, branchName, err);
+    handleCommitError(files, sourceRef, err);
   }
   return result;
 }
@@ -1081,7 +1083,10 @@ export async function commitFiles(
   try {
     const commitResult = await prepareCommit(commitConfig);
     if (commitResult) {
-      const pushResult = await pushCommit(commitConfig);
+      const pushResult = await pushCommit({
+        sourceRef: commitConfig.branchName,
+        files: commitConfig.files,
+      });
       if (pushResult) {
         const { branchName } = commitConfig;
         const { commitSha } = commitResult;

lib/util/git/types.ts

@@ -71,13 +71,20 @@ export interface FileDeletion {
 export type FileChange = FileAddition | FileDeletion;
 
 export interface CommitFilesConfig {
+  baseBranch?: string;
   branchName: string;
   files: FileChange[];
-  message: string;
+  message: string | string[];
   force?: boolean;
   platformCommit?: boolean;
 }
 
+export interface PushFilesConfig {
+  sourceRef: string;
+  targetRef?: string;
+  files: FileChange[];
+}
+
 export type BranchName = string;
 
 export interface CommitResult {

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

@@ -44,6 +44,7 @@ describe('workers/repository/config-migration/branch/create', () => {
       expect(checkoutBranch).toHaveBeenCalledWith(config.defaultBranch);
       expect(commitFiles).toHaveBeenCalledWith({
         branchName: 'renovate/migrate-config',
+        baseBranch: 'master',
         files: [
           {
             type: 'addition',
@@ -64,6 +65,7 @@ describe('workers/repository/config-migration/branch/create', () => {
       expect(checkoutBranch).toHaveBeenCalledWith(config.defaultBranch);
       expect(platform.commitFiles).toHaveBeenCalledWith({
         branchName: 'renovate/migrate-config',
+        baseBranch: 'master',
         files: [
           {
             type: 'addition',
@@ -86,6 +88,7 @@ describe('workers/repository/config-migration/branch/create', () => {
       expect(checkoutBranch).toHaveBeenCalledWith(config.defaultBranch);
       expect(commitFiles).toHaveBeenCalledWith({
         branchName: 'renovate/migrate-config',
+        baseBranch: 'master',
         files: [
           {
             type: 'addition',
@@ -109,6 +112,7 @@ describe('workers/repository/config-migration/branch/create', () => {
         expect(checkoutBranch).toHaveBeenCalledWith(config.defaultBranch);
         expect(commitFiles).toHaveBeenCalledWith({
           branchName: 'renovate/migrate-config',
+          baseBranch: 'master',
           files: [
             {
               type: 'addition',
@@ -133,6 +137,7 @@ describe('workers/repository/config-migration/branch/create', () => {
         expect(checkoutBranch).toHaveBeenCalledWith(config.defaultBranch);
         expect(commitFiles).toHaveBeenCalledWith({
           branchName: 'renovate/migrate-config',
+          baseBranch: 'master',
           files: [
             {
               type: 'addition',
@@ -158,6 +163,7 @@ describe('workers/repository/config-migration/branch/create', () => {
         expect(checkoutBranch).toHaveBeenCalledWith(config.defaultBranch);
         expect(commitFiles).toHaveBeenCalledWith({
           branchName: 'renovate/migrate-config',
+          baseBranch: 'master',
           files: [
             {
               type: 'addition',
@@ -182,6 +188,7 @@ describe('workers/repository/config-migration/branch/create', () => {
         expect(checkoutBranch).toHaveBeenCalledWith(config.defaultBranch);
         expect(commitFiles).toHaveBeenCalledWith({
           branchName: 'renovate/migrate-config',
+          baseBranch: 'master',
           files: [
             {
               type: 'addition',

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

@@ -34,6 +34,7 @@ export async function createConfigMigrationBranch(
     migratedConfigData
   );
   return commitAndPush({
+    baseBranch: config.defaultBranch!,
     branchName: getMigrationBranchName(config),
     files: [
       {

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

@@ -126,6 +126,7 @@ describe('workers/repository/config-migration/branch/rebase', () => {
           ],
           message: `Migrate config ${filename}`,
           platformCommit: false,
+          baseBranch: 'master',
         });
       }
     );

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

@@ -51,6 +51,7 @@ export async function rebaseMigrationBranch(
     migratedConfigData
   );
   return commitAndPush({
+    baseBranch: config.defaultBranch!,
     branchName,
     files: [
       {

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

@@ -34,6 +34,7 @@ export async function createOnboardingBranch(
   }
 
   return commitAndPush({
+    baseBranch: config.baseBranch,
     branchName: config.onboardingBranch!,
     files: [
       {

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

@@ -62,6 +62,7 @@ export async function rebaseOnboardingBranch(
 
   // TODO #7154
   return commitAndPush({
+    baseBranch: config.baseBranch,
     branchName: config.onboardingBranch!,
     files: [
       {

lib/workers/repository/update/branch/__snapshots__/commit.spec.ts.snap

@@ -4,6 +4,7 @@ exports[`workers/repository/update/branch/commit commitFilesToBranch commits fil
 [
   [
     {
+      "baseBranch": undefined,
       "branchName": "renovate/some-branch",
       "files": [
         {
@@ -24,6 +25,7 @@ exports[`workers/repository/update/branch/commit commitFilesToBranch commits via
 [
   [
     {
+      "baseBranch": undefined,
       "branchName": "renovate/some-branch",
       "files": [
         {

lib/workers/repository/update/branch/commit.ts

@@ -52,6 +52,7 @@ export function commitFilesToBranch(
 
   // API will know whether to create new branch or not
   return commitAndPush({
+    baseBranch: config.baseBranch,
     branchName: config.branchName,
     files: updatedFiles,
     message: config.commitMessage!,