Merge pull request #1324 from dotnet/copilot/add-disable-setcloudbuildversionvars-option

Add NBGV_SetCloudBuildVersionVars property to disable cloud build variable output

Author: AArnott

docfx/docs/build-systems/msbuild.md

@@ -50,6 +50,7 @@ Property | Default | Description
 `NBGV_EmitThisAssemblyClass` | `true` | When `false`, suppresses generation of the `ThisAssembly` class.
 `NBGV_ThisAssemblyIncludesPackageVersion` | `false` | When `true`, a `NuGetPackageVersion` property is added to the `ThisAssembly` class.
 `NBGV_UseAssemblyVersionInNativeVersion` | `true` | When `false`, uses the `AssemblyFileVersion` as a native `PRODUCTVERSION`.
+`NBGV_SetCloudBuildVersionVars` | `true` | When `false`, suppresses the `SetCloudBuildVersionVars` target from executing, which sets cloud build version variables (e.g., `##vso[task.setvariable]` commands in Azure DevOps pipelines).
 
 ### Items
 

src/Nerdbank.GitVersioning.Tasks/build/Nerdbank.GitVersioning.targets

@@ -119,7 +119,7 @@
   <Target Name="SetCloudBuildVersionVars"
         DependsOnTargets="GetBuildVersion"
         AfterTargets="GetBuildVersion"
-        Condition=" '@(CloudBuildVersionVars)' != '' ">
+        Condition=" '@(CloudBuildVersionVars)' != '' and '$(NBGV_SetCloudBuildVersionVars)' != 'false' ">
     <Nerdbank.GitVersioning.Tasks.SetCloudBuildVariables
       CloudBuildVersionVars="@(CloudBuildVersionVars)">
       <Output TaskParameter="MSBuildPropertyUpdates" ItemName="_MSBuildPropertyUpdates_Vars" />

test/Nerdbank.GitVersioning.Tests/SomeGitBuildIntegrationTests.cs

@@ -714,6 +714,41 @@ public async Task NativeVersionInfo_CreateNativeResourceDll()
     }
 #endif
 
+    [Theory]
+    [Trait("TestCategory", "FailsInCloudTest")]
+    [MemberData(nameof(CloudBuildVariablesData))]
+    public async Task SetCloudBuildVersionVars_CanBeDisabled(IReadOnlyDictionary<string, string> properties, string expectedMessage, bool setAllVariables)
+    {
+        using (ApplyEnvironmentVariables(properties))
+        {
+            // Disable SetCloudBuildVersionVars target
+            this.testProject.AddProperty("NBGV_SetCloudBuildVersionVars", "false");
+
+            var versionOptions = new VersionOptions
+            {
+                Version = SemanticVersion.Parse("1.0"),
+                CloudBuild = new VersionOptions.CloudBuildOptions { SetAllVariables = setAllVariables, SetVersionVariables = true },
+            };
+            this.WriteVersionFile(versionOptions);
+            this.InitializeSourceControl();
+
+            BuildResults buildResult = await this.BuildAsync();
+            this.AssertStandardProperties(versionOptions, buildResult);
+
+            // Assert GitBuildVersion was NOT set because we disabled the target
+            string notExpectedMessage = UnitTestCloudBuildPrefix + expectedMessage
+                .Replace("{NAME}", "GitBuildVersion")
+                .Replace("{VALUE}", buildResult.BuildVersion);
+            Assert.DoesNotContain(notExpectedMessage, buildResult.LoggedEvents.Select(e => e.Message.TrimEnd()));
+
+            // Assert GitBuildVersionSimple was NOT set
+            notExpectedMessage = UnitTestCloudBuildPrefix + expectedMessage
+                .Replace("{NAME}", "GitBuildVersionSimple")
+                .Replace("{VALUE}", buildResult.BuildVersionSimple);
+            Assert.DoesNotContain(notExpectedMessage, buildResult.LoggedEvents.Select(e => e.Message.TrimEnd()));
+        }
+    }
+
     /// <inheritdoc/>
     protected override GitContext CreateGitContext(string path, string committish = null) => throw new NotImplementedException();
 }