Merge pull request #648 from MiYanni/AddVsDropSNAndRunName

Author: MiYanni

eng/pipelines/official.yml

@@ -6,9 +6,7 @@ pr: none
 
 # Required to set a custom run name within workload-build.yml.
 # See: https://learn.microsoft.com/en-us/azure/devops/pipelines/yaml-schema/pipeline
-# ==========================
-# TODO: Temporarily commenting out updating the build number.
-# appendCommitMessageToRunName: false
+appendCommitMessageToRunName: false
 
 parameters:
 - name: sourceBranch
@@ -30,7 +28,7 @@ parameters:
 - name: azDOPublishFeed
   displayName: AzDO publish feed
   type: string
-  default: public/dotnet10-workloads
+  default: public/dotnet-workloads
 
 - name: dividerVSInsertion
   displayName: '[ ######## VS INSERTION ######## ]'

eng/pipelines/templates/jobs/workload-build.yml

@@ -41,11 +41,18 @@ jobs:
           # Keep only valid characters. Invalid characters include: " / : < > \ | ? @ *
           # Also, strip any trailing '.' characters as those are invalid too.
           $commitMessage = "$(git log -1 --pretty=%s)".Trim() -replace '["\/:<>\\|?@*]|\.{1,}$', ''
-          # Lastly, truncate to 255 max characters: 241 = 255 - 14 (for build number and delimiter, ex: 20250910.13 • )
-          $commitMessage = $commitMessage.Substring(0, [Math]::Min($commitMessage.Length, 241))
-          # ==========================
-          # TODO: Temporarily commenting out updating the build number.
-          # Write-Host "##vso[build.updatebuildnumber]$(Build.BuildNumber) • $commitMessage"
+          # AzDO only allows 255 characters for the run name. But, the run name is used in PublishAssets to create a path to the assets for DARC.
+          # The max length for this asset path is 250 characters. An example path is: assets/symbols/dotnet-workload-versions/{RunName}/Microsoft.NET.Workloads.10.0.100.Msi.arm64.10.101.0-servicing.0.25571.5.symbols.nupkg
+          # To truncate the commit message, let's keep these counts in mind:
+          # ~130: approximate length for the asset path parts that are not the run name
+          # 32: for (potential) workloads version and delimiters (last numeric value can be 2 digits long), ex: 10.0.101-servicing.0.25571.3 • 
+          # 14: for build number and delimiter, ex: 20250910.13 • 
+          # Therefore, 250 - 130 - 32 - 14 = 74 characters. To be extra safe, let's make it 65 characters.
+          $commitMessage = $commitMessage.Substring(0, [Math]::Min($commitMessage.Length, 65))
+          # If the build does not succeed, the run name will contain to what is set below.
+          # If the build does succeed, Workloads.NET.Workloads.csproj will recreate the run name using OfficialBuildId, WorkloadsVersion, and SourceBranchCommitMessage.
+          Write-Host "##vso[task.setvariable variable=SourceBranchCommitMessage]$commitMessage"
+          Write-Host "##vso[build.updatebuildnumber]$(Build.BuildNumber) • $commitMessage"
         displayName: 🟣 Set run name via source branch commit message
         # Name is required to reference the variables created within this build step in other stages.
         name: SetRunName

eng/pipelines/templates/steps/workload-insertion-steps.yml

@@ -31,6 +31,8 @@ steps:
     # Connection: https://dnceng.visualstudio.com/internal/_settings/adminservices?resourceId=5708f1c1-8fb7-4722-a643-020cf89ee26f
     # Docs: https://devdiv.visualstudio.com/DevDiv/_wiki/wikis/DevDiv.wiki/40477/Insert-with-a-WIF-Service-Connection
     ConnectedServiceName: MicroBuildInsertionVS
+    # Connection: https://dnceng.visualstudio.com/internal/_settings/adminservices?resourceId=fd289dd6-7de6-4a3b-b33f-eaf786770fa2
+    ConnectedVSDropServiceName: VSEng-VSDrop-MI
     TargetBranch: ${{ parameters.targetBranch }}
     InsertionTopicBranch: $(InsertionTopicBranch)
     TeamName: $(_TeamName)

src/Microsoft.NET.Workloads/Microsoft.NET.Workloads.csproj

@@ -50,13 +50,13 @@
 
   <ItemGroup>
     <Content Include="$(OutputPath)microsoft.net.workloads.workloadset.json" Pack="true" PackagePath="data" />
-    <None Include="$(ReadmeFile)" Pack="true" PackagePath="\"/>
+    <None Include="$(ReadmeFile)" Pack="true" PackagePath="\" />
   </ItemGroup>
 
   <PropertyGroup Condition="'$(WorkloadsProps)' == ''">
-	<WorkloadsProps>workloads.props</WorkloadsProps>
+    <WorkloadsProps>workloads.props</WorkloadsProps>
   </PropertyGroup>
-	
+
   <Import Project="$(WorkloadsProps)" />
 
   <Target Name="CreateWorkloadSetJson" BeforeTargets="Build">
@@ -99,7 +99,7 @@
         File="$(ReadmeFile)"
         Lines="$([System.IO.File]::ReadAllText($(PackageReadmeFile)).Replace('{SDKWVersion}','$(WorkloadsVersion)'))"
         Overwrite="true"
-        Encoding="UTF-8"/>
+        Encoding="UTF-8" />
   </Target>
 
   <Target Name="CreateVisualStudioMsi" AfterTargets="Build" DependsOnTargets="GetAssemblyVersion;_GenerateMsiVersionString">
@@ -159,4 +159,10 @@
     </CreateLightCommandPackageDrop>
   </Target>
 
+  <Target Name="UpdateRunNameWithWorkloadsVersion" AfterTargets="Build" Condition="'$(TF_BUILD)' != ''">
+    <!-- SOURCEBRANCHCOMMITMESSAGE is set to the Azure Pipelines environment within the SetRunName step. -->
+    <!-- We simply pull it out of the environment variables because trying to set it to an MSBuild property can cause issues in the YAML if the message contains special characters. -->
+    <Message Text="##vso[build.updatebuildnumber]$(OfficialBuildId) • $(WorkloadsVersion) • $(SOURCEBRANCHCOMMITMESSAGE)" Importance="high" />
+  </Target>
+
 </Project>

src/Microsoft.NET.Workloads/workloads.props

@@ -28,4 +28,5 @@
   <ItemGroup Label="Aspire" Condition="$([MSBuild]::VersionLessThanOrEquals('$(VersionMajor)', '9'))">
     <WorkloadManifest Include="Microsoft.NET.Sdk.Aspire" FeatureBand="$(AspireFeatureBand)" Version="$(AspireWorkloadManifestVersion)" />
   </ItemGroup>
+
 </Project>