Align naming: isForTrackedBranchOnly and onlyEvaluateTrackedBranches have been renamed to onlyTrackedBranches

crazycrank · crazycrank · commit 4813944e811d · 2020-01-19T13:29:58.000+01:00
diff --git a/src/GitVersionCore.Tests/GitToolsTestingExtensions.cs b/src/GitVersionCore.Tests/GitToolsTestingExtensions.cs
@@ -14,14 +14,14 @@ public static Config ApplyDefaults(this Config config)
             return config;
         }
 
-        public static VersionVariables GetVersion(this RepositoryFixtureBase fixture, Config configuration = null, IRepository repository = null, string commitId = null, bool isForTrackedBranchOnly = true, string targetBranch = null)
+        public static VersionVariables GetVersion(this RepositoryFixtureBase fixture, Config configuration = null, IRepository repository = null, string commitId = null, bool onlyTrackedBranches = true, string targetBranch = null)
         {
             if (configuration == null)
             {
                 configuration = new Config();
                 ConfigurationProvider.ApplyDefaultsTo(configuration);
             }
-            var gitVersionContext = new GitVersionContext(repository ?? fixture.Repository, targetBranch, configuration, isForTrackedBranchOnly, commitId);
+            var gitVersionContext = new GitVersionContext(repository ?? fixture.Repository, targetBranch, configuration, onlyTrackedBranches, commitId);
             var executeGitVersion = ExecuteGitVersion(gitVersionContext);
             var variables = VariableProvider.GetVariablesFor(executeGitVersion, gitVersionContext.Configuration, gitVersionContext.IsCurrentCommitTagged);
             try
@@ -36,19 +36,19 @@ public static VersionVariables GetVersion(this RepositoryFixtureBase fixture, Co
             }
         }
 
-        public static void AssertFullSemver(this RepositoryFixtureBase fixture, string fullSemver, IRepository repository = null, string commitId = null, bool isForTrackedBranchOnly = true, string targetBranch = null)
+        public static void AssertFullSemver(this RepositoryFixtureBase fixture, string fullSemver, IRepository repository = null, string commitId = null, bool onlyTrackedBranches = true, string targetBranch = null)
         {
-            fixture.AssertFullSemver(new Config(), fullSemver, repository, commitId, isForTrackedBranchOnly, targetBranch);
+            fixture.AssertFullSemver(new Config(), fullSemver, repository, commitId, onlyTrackedBranches, targetBranch);
         }
 
-        public static void AssertFullSemver(this RepositoryFixtureBase fixture, Config configuration, string fullSemver, IRepository repository = null, string commitId = null, bool isForTrackedBranchOnly = true, string targetBranch = null)
+        public static void AssertFullSemver(this RepositoryFixtureBase fixture, Config configuration, string fullSemver, IRepository repository = null, string commitId = null, bool onlyTrackedBranches = true, string targetBranch = null)
         {
             ConfigurationProvider.ApplyDefaultsTo(configuration);
             Console.WriteLine("---------");
 
             try
             {
-                var variables = fixture.GetVersion(configuration, repository, commitId, isForTrackedBranchOnly, targetBranch);
+                var variables = fixture.GetVersion(configuration, repository, commitId, onlyTrackedBranches, targetBranch);
                 variables.FullSemVer.ShouldBe(fullSemver);
             }
             catch (Exception)
diff --git a/src/GitVersionCore.Tests/IntegrationTests/DevelopScenarios.cs b/src/GitVersionCore.Tests/IntegrationTests/DevelopScenarios.cs
@@ -157,7 +157,7 @@ public void WhenDevelopBranchedFromMasterDetachedHead_MinorIsIncreased()
             var commit = fixture.Repository.Head.Tip;
             fixture.Repository.MakeACommit();
             Commands.Checkout(fixture.Repository, commit);
-            fixture.AssertFullSemver("1.1.0-alpha.1", isForTrackedBranchOnly: false);
+            fixture.AssertFullSemver("1.1.0-alpha.1", onlyTrackedBranches: false);
         }
     }
 
diff --git a/src/GitVersionCore.Tests/IntegrationTests/MasterScenarios.cs b/src/GitVersionCore.Tests/IntegrationTests/MasterScenarios.cs
@@ -99,7 +99,7 @@ public void GivenARepositoryWithCommitsButNoTagsWithDetachedHead_VersionShouldBe
             Commands.Checkout(fixture.Repository, commit);
 
             // When
-            fixture.AssertFullSemver("0.1.0+2", isForTrackedBranchOnly: false);
+            fixture.AssertFullSemver("0.1.0+2", onlyTrackedBranches: false);
         }
     }
 
diff --git a/src/GitVersionCore.Tests/IntegrationTests/RemoteRepositoryScenarios.cs b/src/GitVersionCore.Tests/IntegrationTests/RemoteRepositoryScenarios.cs
@@ -70,7 +70,7 @@ public void GivenARemoteGitRepositoryWhenCheckingOutDetachedhead_UsingExistingIm
                 fixture.LocalRepositoryFixture.Repository,
                 fixture.LocalRepositoryFixture.Repository.Head.Tip);
 
-            Should.Throw<WarningException>(() => fixture.AssertFullSemver("0.1.0+4", fixture.LocalRepositoryFixture.Repository, isForTrackedBranchOnly: false),
+            Should.Throw<WarningException>(() => fixture.AssertFullSemver("0.1.0+4", fixture.LocalRepositoryFixture.Repository, onlyTrackedBranches: false),
                 string.Format("It looks like the branch being examined is a detached Head pointing to commit '{0}'. Without a proper branch name GitVersion cannot determine the build version.",
                 fixture.LocalRepositoryFixture.Repository.Head.Tip.Id.ToString(7)));
         }
diff --git a/src/GitVersionCore/GitVersionContext.cs b/src/GitVersionCore/GitVersionContext.cs
@@ -9,17 +9,17 @@ namespace GitVersion
     /// </summary>
     public class GitVersionContext
     {
-        public GitVersionContext(IRepository repository, string targetBranch, Config configuration, bool onlyEvaluateTrackedBranches = false, string commitId = null)
-             : this(repository, GitVersionContext.GetTargetBranch(repository, targetBranch), configuration, onlyEvaluateTrackedBranches, commitId)
+        public GitVersionContext(IRepository repository, string targetBranch, Config configuration, bool onlyTrackedBranches = false, string commitId = null)
+             : this(repository, GitVersionContext.GetTargetBranch(repository, targetBranch), configuration, onlyTrackedBranches, commitId)
         {
         }
 
-        public GitVersionContext(IRepository repository, Branch currentBranch, Config configuration, bool onlyEvaluateTrackedBranches = false, string commitId = null)
+        public GitVersionContext(IRepository repository, Branch currentBranch, Config configuration, bool onlyTrackedBranches = false, string commitId = null)
         {
             Repository = repository;
             RepositoryMetadataProvider = new GitRepoMetadataProvider(repository, configuration);
             FullConfiguration = configuration;
-            OnlyEvaluateTrackedBranches = onlyEvaluateTrackedBranches;
+            TrackedBranchesOnly = onlyTrackedBranches;
 
             if (currentBranch == null)
                 throw new InvalidOperationException("Need a branch to operate on");
@@ -47,7 +47,7 @@ public GitVersionContext(IRepository repository, Branch currentBranch, Config co
 
             if (currentBranch.IsDetachedHead())
             {
-                CurrentBranch = RepositoryMetadataProvider.GetBranchesContainingCommit(CurrentCommit, repository.Branches.ToList(), OnlyEvaluateTrackedBranches).OnlyOrDefault() ?? currentBranch;
+                CurrentBranch = RepositoryMetadataProvider.GetBranchesContainingCommit(CurrentCommit, repository.Branches.ToList(), TrackedBranchesOnly).OnlyOrDefault() ?? currentBranch;
             }
             else
             {
@@ -73,7 +73,7 @@ public GitVersionContext(IRepository repository, Branch currentBranch, Config co
         /// </summary>
         public Config FullConfiguration { get; private set; }
         public SemanticVersion CurrentCommitTaggedVersion { get; private set; }
-        public bool OnlyEvaluateTrackedBranches { get; private set; }
+        public bool TrackedBranchesOnly { get; private set; }
         public EffectiveConfiguration Configuration { get; private set; }
         public IRepository Repository { get; private set; }
         public Branch CurrentBranch { get; private set; }

Original file line number	Diff line number	Diff line change
`@@ -14,14 +14,14 @@ public static Config ApplyDefaults(this Config config)`
`14`	`14`	`return config;`
`15`	`15`	`}`
`16`	`16`
`17`		`- public static VersionVariables GetVersion(this RepositoryFixtureBase fixture, Config configuration = null, IRepository repository = null, string commitId = null, bool isForTrackedBranchOnly = true, string targetBranch = null)`
	`17`	`+ public static VersionVariables GetVersion(this RepositoryFixtureBase fixture, Config configuration = null, IRepository repository = null, string commitId = null, bool onlyTrackedBranches = true, string targetBranch = null)`
`18`	`18`	`{`
`19`	`19`	`if (configuration == null)`
`20`	`20`	`{`
`21`	`21`	`configuration = new Config();`
`22`	`22`	`ConfigurationProvider.ApplyDefaultsTo(configuration);`
`23`	`23`	`}`
`24`		`- var gitVersionContext = new GitVersionContext(repository ?? fixture.Repository, targetBranch, configuration, isForTrackedBranchOnly, commitId);`
	`24`	`+ var gitVersionContext = new GitVersionContext(repository ?? fixture.Repository, targetBranch, configuration, onlyTrackedBranches, commitId);`
`25`	`25`	`var executeGitVersion = ExecuteGitVersion(gitVersionContext);`
`26`	`26`	`var variables = VariableProvider.GetVariablesFor(executeGitVersion, gitVersionContext.Configuration, gitVersionContext.IsCurrentCommitTagged);`
`27`	`27`	`try`
`@@ -36,19 +36,19 @@ public static VersionVariables GetVersion(this RepositoryFixtureBase fixture, Co`
`36`	`36`	`}`
`37`	`37`	`}`
`38`	`38`
`39`		`- public static void AssertFullSemver(this RepositoryFixtureBase fixture, string fullSemver, IRepository repository = null, string commitId = null, bool isForTrackedBranchOnly = true, string targetBranch = null)`
	`39`	`+ public static void AssertFullSemver(this RepositoryFixtureBase fixture, string fullSemver, IRepository repository = null, string commitId = null, bool onlyTrackedBranches = true, string targetBranch = null)`
`40`	`40`	`{`
`41`		`- fixture.AssertFullSemver(new Config(), fullSemver, repository, commitId, isForTrackedBranchOnly, targetBranch);`
	`41`	`+ fixture.AssertFullSemver(new Config(), fullSemver, repository, commitId, onlyTrackedBranches, targetBranch);`
`42`	`42`	`}`
`43`	`43`
`44`		`- public static void AssertFullSemver(this RepositoryFixtureBase fixture, Config configuration, string fullSemver, IRepository repository = null, string commitId = null, bool isForTrackedBranchOnly = true, string targetBranch = null)`
	`44`	`+ public static void AssertFullSemver(this RepositoryFixtureBase fixture, Config configuration, string fullSemver, IRepository repository = null, string commitId = null, bool onlyTrackedBranches = true, string targetBranch = null)`
`45`	`45`	`{`
`46`	`46`	`ConfigurationProvider.ApplyDefaultsTo(configuration);`
`47`	`47`	`Console.WriteLine("---------");`
`48`	`48`
`49`	`49`	`try`
`50`	`50`	`{`
`51`		`- var variables = fixture.GetVersion(configuration, repository, commitId, isForTrackedBranchOnly, targetBranch);`
	`51`	`+ var variables = fixture.GetVersion(configuration, repository, commitId, onlyTrackedBranches, targetBranch);`
`52`	`52`	`variables.FullSemVer.ShouldBe(fullSemver);`
`53`	`53`	`}`
`54`	`54`	`catch (Exception)`
Original file line number	Diff line number	Diff line change
`@@ -157,7 +157,7 @@ public void WhenDevelopBranchedFromMasterDetachedHead_MinorIsIncreased()`
`157`	`157`	`var commit = fixture.Repository.Head.Tip;`
`158`	`158`	`fixture.Repository.MakeACommit();`
`159`	`159`	`Commands.Checkout(fixture.Repository, commit);`
`160`		`- fixture.AssertFullSemver("1.1.0-alpha.1", isForTrackedBranchOnly: false);`
	`160`	`+ fixture.AssertFullSemver("1.1.0-alpha.1", onlyTrackedBranches: false);`
`161`	`161`	`}`
`162`	`162`	`}`
`163`	`163`
Original file line number	Diff line number	Diff line change
`@@ -99,7 +99,7 @@ public void GivenARepositoryWithCommitsButNoTagsWithDetachedHead_VersionShouldBe`
`99`	`99`	`Commands.Checkout(fixture.Repository, commit);`
`100`	`100`
`101`	`101`	`// When`
`102`		`- fixture.AssertFullSemver("0.1.0+2", isForTrackedBranchOnly: false);`
	`102`	`+ fixture.AssertFullSemver("0.1.0+2", onlyTrackedBranches: false);`
`103`	`103`	`}`
`104`	`104`	`}`
`105`	`105`
Original file line number	Diff line number	Diff line change
`@@ -70,7 +70,7 @@ public void GivenARemoteGitRepositoryWhenCheckingOutDetachedhead_UsingExistingIm`
`70`	`70`	`fixture.LocalRepositoryFixture.Repository,`
`71`	`71`	`fixture.LocalRepositoryFixture.Repository.Head.Tip);`
`72`	`72`
`73`		`- Should.Throw<WarningException>(() => fixture.AssertFullSemver("0.1.0+4", fixture.LocalRepositoryFixture.Repository, isForTrackedBranchOnly: false),`
	`73`	`+ Should.Throw<WarningException>(() => fixture.AssertFullSemver("0.1.0+4", fixture.LocalRepositoryFixture.Repository, onlyTrackedBranches: false),`
`74`	`74`	`string.Format("It looks like the branch being examined is a detached Head pointing to commit '{0}'. Without a proper branch name GitVersion cannot determine the build version.",`
`75`	`75`	`fixture.LocalRepositoryFixture.Repository.Head.Tip.Id.ToString(7)));`
`76`	`76`	`}`
Original file line number	Diff line number	Diff line change
`@@ -9,17 +9,17 @@ namespace GitVersion`
`9`	`9`	`/// </summary>`
`10`	`10`	`public class GitVersionContext`
`11`	`11`	`{`
`12`		`- public GitVersionContext(IRepository repository, string targetBranch, Config configuration, bool onlyEvaluateTrackedBranches = false, string commitId = null)`
`13`		`- : this(repository, GitVersionContext.GetTargetBranch(repository, targetBranch), configuration, onlyEvaluateTrackedBranches, commitId)`
	`12`	`+ public GitVersionContext(IRepository repository, string targetBranch, Config configuration, bool onlyTrackedBranches = false, string commitId = null)`
	`13`	`+ : this(repository, GitVersionContext.GetTargetBranch(repository, targetBranch), configuration, onlyTrackedBranches, commitId)`
`14`	`14`	`{`
`15`	`15`	`}`
`16`	`16`
`17`		`- public GitVersionContext(IRepository repository, Branch currentBranch, Config configuration, bool onlyEvaluateTrackedBranches = false, string commitId = null)`
	`17`	`+ public GitVersionContext(IRepository repository, Branch currentBranch, Config configuration, bool onlyTrackedBranches = false, string commitId = null)`
`18`	`18`	`{`
`19`	`19`	`Repository = repository;`
`20`	`20`	`RepositoryMetadataProvider = new GitRepoMetadataProvider(repository, configuration);`
`21`	`21`	`FullConfiguration = configuration;`
`22`		`- OnlyEvaluateTrackedBranches = onlyEvaluateTrackedBranches;`
	`22`	`+ TrackedBranchesOnly = onlyTrackedBranches;`
`23`	`23`
`24`	`24`	`if (currentBranch == null)`
`25`	`25`	`throw new InvalidOperationException("Need a branch to operate on");`
`@@ -47,7 +47,7 @@ public GitVersionContext(IRepository repository, Branch currentBranch, Config co`
`47`	`47`
`48`	`48`	`if (currentBranch.IsDetachedHead())`
`49`	`49`	`{`
`50`		`- CurrentBranch = RepositoryMetadataProvider.GetBranchesContainingCommit(CurrentCommit, repository.Branches.ToList(), OnlyEvaluateTrackedBranches).OnlyOrDefault() ?? currentBranch;`
	`50`	`+ CurrentBranch = RepositoryMetadataProvider.GetBranchesContainingCommit(CurrentCommit, repository.Branches.ToList(), TrackedBranchesOnly).OnlyOrDefault() ?? currentBranch;`
`51`	`51`	`}`
`52`	`52`	`else`
`53`	`53`	`{`
`@@ -73,7 +73,7 @@ public GitVersionContext(IRepository repository, Branch currentBranch, Config co`
`73`	`73`	`/// </summary>`
`74`	`74`	`public Config FullConfiguration { get; private set; }`
`75`	`75`	`public SemanticVersion CurrentCommitTaggedVersion { get; private set; }`
`76`		`- public bool OnlyEvaluateTrackedBranches { get; private set; }`
	`76`	`+ public bool TrackedBranchesOnly { get; private set; }`
`77`	`77`	`public EffectiveConfiguration Configuration { get; private set; }`
`78`	`78`	`public IRepository Repository { get; private set; }`
`79`	`79`	`public Branch CurrentBranch { get; private set; }`