feat(onboarding): merge onboardingBranch into baseBranch

lib/util/git/index.spec.ts

@@ -344,6 +344,12 @@ describe('util/git/index', () => {
       expect(merged.all).toContain('renovate/future_branch');
     });
 
+    it('does not push if pushToRemote=false', async () => {
+      const pushSpy = jest.spyOn(SimpleGit.prototype, 'push');
+      await git.mergeBranch('renovate/future_branch', false);
+      expect(pushSpy).toHaveBeenCalledTimes(0);
+    });
+
     it('should throw if branch merge throws', async () => {
       await expect(git.mergeBranch('not_found')).rejects.toThrow();
     });

lib/util/git/index.ts

@@ -768,7 +768,10 @@ export async function deleteBranch(branchName: string): Promise<void> {
   delete config.branchCommits[branchName];
 }
 
-export async function mergeBranch(branchName: string): Promise<void> {
+export async function mergeBranch(
+  branchName: string,
+  pushToRemote = true
+): Promise<void> {
   let status: StatusResult | undefined;
   try {
     await syncGit();
@@ -784,8 +787,12 @@ export async function mergeBranch(branchName: string): Promise<void> {
       ])
     );
     status = await git.status();
-    await gitRetry(() => git.merge(['--ff-only', branchName]));
-    await gitRetry(() => git.push('origin', config.currentBranch));
+    if (pushToRemote) {
+      await gitRetry(() => git.merge(['--ff-only', branchName]));
+      await gitRetry(() => git.push('origin', config.currentBranch));
+    } else {
+      await gitRetry(() => git.merge([branchName]));
+    }
     incLimitedValue('Commits');
   } catch (err) {
     logger.debug(

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

@@ -258,10 +258,27 @@ describe('workers/repository/onboarding/branch/index', () => {
       const res = await checkOnboardingBranch(config);
       expect(res.repoIsOnboarded).toBeFalse();
       expect(res.branchList).toEqual(['renovate/configure']);
-      expect(git.checkoutBranch).toHaveBeenCalledTimes(1);
+      expect(git.mergeBranch).toHaveBeenCalledTimes(1);
       expect(scm.commitAndPush).toHaveBeenCalledTimes(0);
     });
 
+    it('ensures comment on pr when branch is conflicted', async () => {
+      scm.isBranchConflicted.mockResolvedValueOnce(true);
+      git.getFileList.mockResolvedValue(['package.json']);
+      platform.getBranchPr.mockResolvedValueOnce(
+        mock<Pr>({
+          number: 12,
+        })
+      );
+      rebase.rebaseOnboardingBranch.mockResolvedValueOnce('123test');
+      const res = await checkOnboardingBranch(config);
+      expect(res.repoIsOnboarded).toBeFalse();
+      expect(res.branchList).toEqual(['renovate/configure']);
+      expect(git.mergeBranch).toHaveBeenCalledTimes(0);
+      expect(scm.commitAndPush).toHaveBeenCalledTimes(0);
+      expect(platform.ensureComment).toHaveBeenCalledTimes(1);
+    });
+
     describe('tests onboarding rebase/retry checkbox handling', () => {
       beforeEach(() => {
         GlobalConfig.set({ platform: 'github' });
@@ -283,7 +300,7 @@ describe('workers/repository/onboarding/branch/index', () => {
           `Platform '${pl}' does not support extended markdown`
         );
         expect(OnboardingState.prUpdateRequested).toBeTrue();
-        expect(git.checkoutBranch).toHaveBeenCalledTimes(1);
+        expect(git.mergeBranch).toHaveBeenCalledTimes(1);
         expect(scm.commitAndPush).toHaveBeenCalledTimes(0);
       });
 
@@ -297,7 +314,7 @@ describe('workers/repository/onboarding/branch/index', () => {
           `No rebase checkbox was found in the onboarding PR`
         );
         expect(OnboardingState.prUpdateRequested).toBeTrue();
-        expect(git.checkoutBranch).toHaveBeenCalledTimes(1);
+        expect(git.mergeBranch).toHaveBeenCalledTimes(1);
         expect(scm.commitAndPush).toHaveBeenCalledTimes(0);
       });
 
@@ -312,7 +329,7 @@ describe('workers/repository/onboarding/branch/index', () => {
         );
         expect(OnboardingState.prUpdateRequested).toBeTrue();
         ``;
-        expect(git.checkoutBranch).toHaveBeenCalledTimes(1);
+        expect(git.mergeBranch).toHaveBeenCalledTimes(1);
         expect(scm.commitAndPush).toHaveBeenCalledTimes(0);
       });
 
@@ -323,7 +340,7 @@ describe('workers/repository/onboarding/branch/index', () => {
         await checkOnboardingBranch(config);
 
         expect(OnboardingState.prUpdateRequested).toBeFalse();
-        expect(git.checkoutBranch).toHaveBeenCalledTimes(1);
+        expect(git.mergeBranch).toHaveBeenCalledTimes(1);
         expect(scm.commitAndPush).toHaveBeenCalledTimes(0);
       });
     });

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

@@ -8,7 +8,10 @@ import {
 } from '../../../../constants/error-messages';
 import { logger } from '../../../../logger';
 import { Pr, platform } from '../../../../modules/platform';
-import { checkoutBranch, setGitAuthor } from '../../../../util/git';
+import { ensureComment } from '../../../../modules/platform/comment';
+import { scm } from '../../../../modules/platform/scm';
+import { emojify } from '../../../../util/emoji';
+import { mergeBranch, setGitAuthor } from '../../../../util/git';
 import { extractAllDependencies } from '../../extract';
 import { mergeRenovateConfig } from '../../init/merge';
 import { OnboardingState } from '../common';
@@ -23,6 +26,7 @@ export async function checkOnboardingBranch(
   logger.debug('checkOnboarding()');
   logger.trace({ config });
   let onboardingBranch = config.onboardingBranch;
+  let isConflicted = false;
   const repoIsOnboarded = await isOnboarded(config);
   if (repoIsOnboarded) {
     logger.debug('Repo is onboarded');
@@ -36,6 +40,21 @@ export async function checkOnboardingBranch(
   setGitAuthor(config.gitAuthor);
   const onboardingPr = await getOnboardingPr(config);
   if (onboardingPr) {
+    isConflicted = await scm.isBranchConflicted(
+      config.baseBranch!,
+      config.onboardingBranch!
+    );
+    if (isConflicted) {
+      // if branch is conflcted ensure comment
+      await ensureComment({
+        number: onboardingPr.number,
+        topic: 'Branch Conflicted',
+        content: emojify(
+          `:warning: This PR has a merge conflict. However, Renovate is unable to automatically fix that due to edits in this branch. Please resolve the merge conflict manually.\n\n`
+        ),
+      });
+    }
+
     if (config.onboardingRebaseCheckbox) {
       handleOnboardingManualRebase(onboardingPr);
     }
@@ -81,9 +100,11 @@ export async function checkOnboardingBranch(
     }
   }
   if (!GlobalConfig.get('dryRun')) {
-    logger.debug('Checkout onboarding branch.');
     // TODO #7154
-    await checkoutBranch(onboardingBranch!);
+    if (!isConflicted) {
+      logger.debug('Merge onboarding branch in default branch');
+      await mergeBranch(onboardingBranch!, false);
+    }
   }
   // TODO #7154
   const branchList = [onboardingBranch!];

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

@@ -201,21 +201,6 @@ describe('workers/repository/onboarding/pr/index', () => {
       }
     );
 
-    it('updates PR when conflicted', async () => {
-      config.baseBranch = 'some-branch';
-      platform.getBranchPr.mockResolvedValueOnce(
-        partial<Pr>({
-          title: 'Configure Renovate',
-          bodyStruct,
-        })
-      );
-      scm.isBranchConflicted.mockResolvedValueOnce(true);
-      scm.isBranchModified.mockResolvedValueOnce(true);
-      await ensureOnboardingPr(config, {}, branches);
-      expect(platform.createPr).toHaveBeenCalledTimes(0);
-      expect(platform.updatePr).toHaveBeenCalledTimes(1);
-    });
-
     it('updates PR when modified', async () => {
       config.baseBranch = 'some-branch';
       platform.getBranchPr.mockResolvedValueOnce(
@@ -251,7 +236,6 @@ describe('workers/repository/onboarding/pr/index', () => {
           bodyStruct,
         })
       );
-      scm.isBranchConflicted.mockResolvedValueOnce(true);
       scm.isBranchModified.mockResolvedValueOnce(true);
       await ensureOnboardingPr(config, {}, branches);
       expect(logger.info).toHaveBeenCalledWith(

lib/workers/repository/onboarding/pr/index.ts

@@ -102,17 +102,7 @@ If you need any further assistance then you can also [request help here](${
         config.productLinks!.help
       }) if you have any doubts and would like it reviewed.\n\n`
     );
-    const isConflicted = await scm.isBranchConflicted(
-      config.baseBranch!,
-      config.onboardingBranch!
-    );
-    if (isConflicted) {
-      configDesc += emojify(
-        `:warning: This PR has a merge conflict. However, Renovate is unable to automatically fix that due to edits in this branch. Please resolve the merge conflict manually.\n\n`
-      );
-    } else {
-      configDesc += `Important: Now that this branch is edited, Renovate can't rebase it from the base branch any more. If you make changes to the base branch that could impact this onboarding PR, please merge them manually.\n\n`;
-    }
+    configDesc += `Important: Now that this branch is edited, Renovate can't rebase it from the base branch any more. If you make changes to the base branch that could impact this onboarding PR, please merge them manually.\n\n`;
   } else {
     configDesc = getConfigDesc(config, packageFiles!);
   }