Add Merge-Main.ps1 script by hallipr · Pull Request #30676 · Azure/azure-sdk-for-java

hallipr · 2022-08-27T08:31:38Z

Add script for merging main into the long-lived spring feature branches.

Given a feature/spring branch like:

eng/
    drift.ps1
    versioning/
        external_dependencies.txt  (with changes)
        drift.txt
sdk/
    not-spring/
         pom.xml
         drift.md
    spring/
         pom.xml
         v3.txt

And a main branch like:

eng/
    versioning/
        external_dependencies.txt  (with conflicting changes)
sdk/
    not-spring/
         pom.xml
    something-new/
         pom.xml
    spring/
         pom.xml
         v2.txt

After running Merge-Main.ps1, we would expect an in-progress merge commit like:

Changes to be committed:
        deleted:    eng/drift.ps1
        deleted:    eng/versioning/drift.txt
        deleted:    sdk/not-spring/drift.md
        modified:   sdk/not-spring/pom.xml
        new file:   sdk/something-new/pom.xml

Unmerged paths:
  (use "git add <file>..." to mark resolution)
        both modified:   eng/versioning/external_dependencies.txt

The net effect being:

the sdk/spring folder remained untouched even though it differs from main.
txt files in eng/versioning are merged from main
except for sdk/spring, any file not in main is deleted from the current branch
all other files are copied from main, overwriting the current branch
the merge is waiting for remaining conflicts to be manually resolved

benbp · 2022-09-01T00:37:40Z

+&git merge $Source --no-ff --no-commit
+
+# update paths matching "theirs" except for "ours" and "merge" to the state in $Source
+&git restore -s $Source --staged --worktree -- ":(top,glob)$Theirs" $ourExcludes $mergeExcludes
+
+# update paths matching "ours" except for "merge" to their pre-merge state
+&git restore -s (git rev-parse HEAD) --staged --worktree -- ":(top,glob)$Ours" $mergeExcludes


I think it would be useful to handle exit codes at each of these steps.

Also, is the ampersand necessary?

I added an error message function and removed the ampersands

moarychan · 2022-09-02T03:38:17Z

+param(
+    [string]$Source = 'main',
+    [string[]]$Theirs = @('**'), # paths to always overwrite
+    [string[]]$Ours = @('sdk/spring'), # paths to never merge or overwrite


spring-experimental should be excluded like spring, the new service directory sdk/jdbc is coming in the main branch, which may be excluded later.

I added spring-experimental to $Ours.

moarychan

LGTM, I will test the script later, thanks @hallipr

…ters

weshaggard · 2022-09-19T23:51:10Z

+# This script can be run locally from the root of the repo:
+# .\eng\scripts\Merge-Branch.ps1 -SourceBranch 'main' -Theirs '**' -Ours 'sdk/template' -Merge 'sdk/template/ci.yml', '**/README.md'
+#
+# This would merge main into the local branch, making the working folder look like main. It not overwrite sdk\template.


Suggested change

# This would merge main into the local branch, making the working folder look like main. It not overwrite sdk\template.

# This would merge main into the local branch, making the working folder look like main. It will not overwrite sdk\template.

fixed in pr #31222

weshaggard · 2022-09-19T23:53:05Z

+    [string[]]$Merge # paths to merge or overwrite
+)
+
+$theirIncludes = @($Theirs | ForEach-Object { ":(top,glob)$_" })


What are these magic include filters? Can you link to the git documentation covering them in a comment?

Comments added to script in pr #31222

weshaggard · 2022-09-19T23:55:00Z

+"  Use `"git commit --no-edit`" to complete the merge with the default merge message`n" `
+"  Use `"git commit -m <message>`" to complete the merge with a custom message"
+
+exit 0


Isn't there still potential for merge conflicts? If so we should try to detect that and output a message about those conflicts.

git outputs the appropriate message. It appears in the output just above our "Merge commit started" message

moarychan · 2022-09-26T06:33:58Z

@hallipr , please note I have renamed the target branch name to feature/spring-boot-3.

moarychan · 2022-09-28T10:33:56Z

Hi @hallipr , I will sync code from main to feature/spring-boot-3 now, please help to raise a new PR if any comments should be resolved.

Use some form of Merge-Branch.ps1 to do the partial sync see Azure/azure-sdk-for-java#30676 see Azure/azure-rest-api-specs-pr#12958

Add Merge-Main.ps1 script

7f4f056

hallipr requested review from Netyyyy, backwind1233, chenrujun, hui1110, moarychan, saragluna, stliu and yiliuTo as code owners August 27, 2022 08:31

ghost added the azure-spring All azure-spring related issues label Aug 27, 2022

hallipr requested a review from benbp August 27, 2022 22:04

benbp reviewed Sep 1, 2022

View reviewed changes

JimSuplizio self-requested a review September 1, 2022 21:52

hallipr added 2 commits September 1, 2022 15:15

Remove unnecessary ampersands and add LASTEXITCODE checking

7d2689f

Add ErrorExit function

03c0a89

moarychan added this to the 2022-09 milestone Sep 2, 2022

moarychan requested changes Sep 2, 2022

View reviewed changes

benbp approved these changes Sep 2, 2022

View reviewed changes

moarychan approved these changes Sep 5, 2022

View reviewed changes

saragluna assigned moarychan Sep 6, 2022

saragluna modified the milestones: 2022-09, 2022-10 Sep 6, 2022

hallipr requested a review from weshaggard as a code owner September 15, 2022 00:06

hallipr force-pushed the pahallis/spring-merge-script branch from b45b3b0 to 9919c82 Compare September 15, 2022 00:06

Create common Merge-Branch script and have Spring call it with parame…

adb4a2c

…ters

hallipr force-pushed the pahallis/spring-merge-script branch from 9919c82 to adb4a2c Compare September 15, 2022 00:18

hallipr added 2 commits September 14, 2022 17:24

Fix parameter formatting for git pathspecs

85c8f6b

Fix paths in Merge-Branch example to use forward slashes

1c73c5e

hallipr requested a review from moarychan September 15, 2022 00:35

weshaggard reviewed Sep 19, 2022

View reviewed changes

moarychan merged commit 5b57146 into feature/spring-boot-3 Sep 28, 2022

moarychan deleted the pahallis/spring-merge-script branch September 28, 2022 10:34

weshaggard added a commit to weshaggard/azure-sdk-tools that referenced this pull request Jun 8, 2023

Initial work for branch sync

8e6986e

Use some form of Merge-Branch.ps1 to do the partial sync see Azure/azure-sdk-for-java#30676 see Azure/azure-rest-api-specs-pr#12958

	# This would merge main into the local branch, making the working folder look like main. It not overwrite sdk\template.
	# This would merge main into the local branch, making the working folder look like main. It will not overwrite sdk\template.

Uh oh!

Conversation

hallipr commented Aug 27, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

hallipr Sep 1, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

moarychan left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

moarychan commented Sep 26, 2022

Uh oh!

moarychan commented Sep 28, 2022

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

hallipr commented Aug 27, 2022 •

edited

Loading

hallipr Sep 1, 2022 •

edited

Loading