Support --targetBranch for Azure Devops Server/TFS for remote repos…

…itories (#1008)

* chore: Improve targetBranch's description

* test: Verify targetBranch is used for remote tfs

Add test to verify that when a custom value is provided to the
`--targetBranch` option, the `TfsSettingsReader` properly populates the
`RemoteInfo.BranchName` property in case of a remote URI for the
repository.

* feat(tfs): Support targetBranch for remote URIs

Currently the `repository` command does not make use of the custom value
provided through the `--targetBranch` option when the URI points to a
remote repository, not a local one.

This was the case because the `TfsSettingsReader` did not make use of
the value in case of a remote URI.

This commit simply instantiates a new `RemoteInfo` with `BranchName` set
to the provided value in case of a remote URI.

* docs: Add ADServer/TFS as supporting targetBranch

NuKeeper.AzureDevOps/TfsSettingsReader.cs

@@ -53,7 +53,7 @@ public override async Task<RepositorySettings> RepositorySettings(Uri repository
 
             var settings = repositoryUri.IsFile
                 ? await CreateSettingsFromLocal(repositoryUri, targetBranch)
-                : CreateSettingsFromRemote(repositoryUri);
+                : CreateSettingsFromRemote(repositoryUri, targetBranch);
             if (settings == null)
             {
                 throw new NuKeeperException($"The provided uri was is not in the correct format. Provided {repositoryUri.ToString()} and format should be {UrlPattern}");
@@ -64,9 +64,9 @@ public override async Task<RepositorySettings> RepositorySettings(Uri repository
             return settings;
         }
 
-        private static RepositorySettings CreateSettingsFromRemote(Uri repositoryUri)
+        private static RepositorySettings CreateSettingsFromRemote(Uri repositoryUri, string targetBranch)
         {
-            return RepositorySettings(repositoryUri);
+            return RepositorySettings(repositoryUri, new RemoteInfo { BranchName = targetBranch });
         }
 
         private async Task<RepositorySettings> CreateSettingsFromLocal(Uri repositoryUri, string targetBranch)

NuKeeper/Commands/RepositoryCommand.cs

@@ -32,7 +32,7 @@ public RepositoryCommand(ICollaborationEngine engine, IConfigureLogger logger, I
         public string RepositoryUri { get; set; }
 
         [Option(CommandOptionType.SingleValue, LongName = "targetBranch",
-            Description = "If the target branch is another branch than that you are currently on, set this to the target")]
+            Description = "Use another target branch than the currently active HEAD branch of the remote or local repository")]
         public string TargetBranch { get; set; }
 
         [Option(CommandOptionType.SingleValue, ShortName = "cdir", Description = "If you want NuKeeper to check out the repository to an alternate path, set it here (by default, a temporary directory is used).")]

Nukeeper.AzureDevOps.Tests/TfsSettingsReaderTests.cs

@@ -120,5 +120,15 @@ public async Task RepositorySettings_HandlesSpaces()
             Assert.AreEqual("project name", settings.RepositoryOwner);
         }
 
+        [Test]
+        public async Task RepositorySettings_WithRemoteUrlAndTargetBranch_ReturnsRemoteInfoWithSpecifiedBranchName()
+        {
+            var uri = new Uri("https://internalserver/tfs/project%20name/_git/repo%20name");
+            var targetBranch = "myTargetBranch";
+
+            var settings = await _azureSettingsReader.RepositorySettings(uri, targetBranch);
+
+            Assert.AreEqual("myTargetBranch", settings.RemoteInfo.BranchName);
+        }
     }
 }

site/content/commands/repository.md

@@ -50,7 +50,7 @@ This is only available for azure devops and vsts
 ### Using a targetBranch
 
 {{% notice info %}}
-This is only available for azure devops, vsts and github right now
+This is only available for azure devops, azure devops server, vsts, tfs, and github right now
 {{% /notice %}}
 
 In some cases you want NuKeeper not to run on the default branch but on a specific (feature-)branch