Skip to content

Feature/merge message releases #3966

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 4 commits into from
Closed

Feature/merge message releases #3966

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
e1d8723
Extend MergeMessageVersionStrategy
Mar 17, 2024
240f4f8
Use merge message strategy for squash merged releases
Mar 17, 2024
14920b7
Set mergeMessage to null if merge commit isn't valid.
Mar 29, 2024
6dc8f70
Override hotfix branch configuration in UnitTest
Mar 29, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 13 additions & 8 deletions ...tVersion.Core.Tests/VersionCalculation/Strategies/MergeMessageBaseVersionStrategyTests.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -52,6 +52,7 @@ public void ShouldNotAllowIncrementOfVersion()
[TestCase("Merge branch 'Release-v0.2.0'", true, "0.2.0")]
[TestCase("Merge remote-tracking branch 'origin/release/0.8.0' into develop/" + MainBranch, true, "0.8.0")]
[TestCase("Merge remote-tracking branch 'refs/remotes/origin/release/2.0.0'", true, "2.0.0")]
[TestCase("Merge branch 'Releases/0.2.0'", false, "0.2.0")] // Support Squash Commits
public void TakesVersionFromMergeOfReleaseBranch(string message, bool isMergeCommit, string expectedVersion)
{
var parents = GetParents(isMergeCommit);
Expand Down Expand Up @@ -81,15 +82,19 @@ public void TakesVersionFromMergeOfReleaseBranch(string message, bool isMergeCom
[TestCase("Finish 0.14.1", true)] // Don't support Syntevo SmartGit/Hg's Gitflow merge commit messages for finishing a 'Hotfix' branch
public void ShouldNotTakeVersionFromMergeOfNonReleaseBranch(string message, bool isMergeCommit)
{
var configurationBuilder = GitFlowConfigurationBuilder.New;
configurationBuilder.WithBranch("hotfix", builder => builder.WithIsReleaseBranch(false));
ConfigurationHelper configurationHelper = new(configurationBuilder.Build());
var configurationDictionary = configurationHelper.Dictionary;
var parents = GetParents(isMergeCommit);
AssertMergeMessage(message, null, parents);
AssertMergeMessage(message + " ", null, parents);
AssertMergeMessage(message + "\r ", null, parents);
AssertMergeMessage(message + "\r", null, parents);
AssertMergeMessage(message + "\r\n", null, parents);
AssertMergeMessage(message + "\r\n ", null, parents);
AssertMergeMessage(message + "\n", null, parents);
AssertMergeMessage(message + "\n ", null, parents);
AssertMergeMessage(message, null, parents, configurationDictionary);
AssertMergeMessage(message + " ", null, parents, configurationDictionary);
AssertMergeMessage(message + "\r ", null, parents, configurationDictionary);
AssertMergeMessage(message + "\r", null, parents, configurationDictionary);
AssertMergeMessage(message + "\r\n", null, parents, configurationDictionary);
AssertMergeMessage(message + "\r\n ", null, parents, configurationDictionary);
AssertMergeMessage(message + "\n", null, parents, configurationDictionary);
AssertMergeMessage(message + "\n ", null, parents, configurationDictionary);
}

[TestCase("Merge pull request #165 from organization/Particular/release-1.0.0", true)]
Expand Down
11 changes: 7 additions & 4 deletions src/GitVersion.Core/MergeMessage.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -96,13 +96,16 @@ public static bool TryParse(
mergeCommit.NotNull();
configuration.NotNull();

mergeMessage = null;
mergeMessage = new(mergeCommit.Message, configuration);
Copy link
Member

@asbjornu asbjornu Mar 28, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

mergeMessage should not be set if the return value equals false.

Copy link
Contributor Author

@DSpirit DSpirit Mar 29, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Understood, I've changed it.


if (mergeCommit.IsMergeCommit)
var isReleaseBranch = mergeMessage.MergedBranch != null && configuration.IsReleaseBranch(mergeMessage.MergedBranch);
var isValidMergeCommit = mergeCommit.IsMergeCommit || isReleaseBranch;

if (!isValidMergeCommit)
{
mergeMessage = new(mergeCommit.Message, configuration);
mergeMessage = null;
}

return mergeMessage != null;
return isValidMergeCommit;
}
}
14 changes: 4 additions & 10 deletions ...GitVersion.Core/VersionCalculation/VersionSearchStrategies/MergeMessageVersionStrategy.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -67,14 +67,8 @@ private static bool TryParse(ICommit mergeCommit, GitVersionContext context, [No
return mergeMessage != null;
}

private static MergeMessage? Inner(ICommit mergeCommit, GitVersionContext context)
{
if (mergeCommit.Parents.Count() < 2)
{
return null;
}

var mergeMessage = new MergeMessage(mergeCommit.Message, context.Configuration);
return mergeMessage;
}
private static MergeMessage? Inner(ICommit mergeCommit, GitVersionContext context) =>
MergeMessage.TryParse(mergeCommit, context.Configuration, out MergeMessage? mergeMessage)
? mergeMessage
: null;
}