Scarse checkout: clean up, deprecation.

gfraiteur · gfraiteur · commit f75f79466c9c · 2025-09-30T11:47:50.000+02:00
diff --git a/src/PostSharp.Engineering.BuildTools/ContinuousIntegration/Model/AdditionalCiBuildConfiguration.cs b/src/PostSharp.Engineering.BuildTools/ContinuousIntegration/Model/AdditionalCiBuildConfiguration.cs
@@ -1,10 +1,12 @@
 ﻿// Copyright (c) SharpCrafters s.r.o. See the LICENSE.md file in the root directory of this repository root for details.
 
+using JetBrains.Annotations;
 using PostSharp.Engineering.BuildTools.ContinuousIntegration.TeamCity;
 using PostSharp.Engineering.BuildTools.ContinuousIntegration.TeamCity.Generation;
 
 namespace PostSharp.Engineering.BuildTools.ContinuousIntegration.Model;
 
+[PublicAPI]
 public abstract class AdditionalCiBuildConfiguration
 {
     public string Name { get; }
@@ -25,11 +27,4 @@ protected AdditionalCiBuildConfiguration( string id, string name, string branch
     }
 
     internal abstract TeamCityBuildConfiguration TeamCityBuildConfiguration( ProductProperties productProperties );
-}
-
-public enum SourceDependenciesRequirements
-{
-    None,
-    Full,
-    EngOnly
 }
diff --git a/src/PostSharp.Engineering.BuildTools/ContinuousIntegration/Model/PowershellAdditionalCiBuildConfiguration.cs b/src/PostSharp.Engineering.BuildTools/ContinuousIntegration/Model/PowershellAdditionalCiBuildConfiguration.cs
@@ -45,7 +45,9 @@ internal override TeamCityBuildConfiguration TeamCityBuildConfiguration( Product
             SourceDependencies = this.SourceDependenciesRequirements switch
             {
                 SourceDependenciesRequirements.None => [],
+#pragma warning disable CS0618 // Type or member is obsolete
                 SourceDependenciesRequirements.EngOnly => productProperties.EngOnlySourceDependencies,
+#pragma warning restore CS0618 // Type or member is obsolete
                 SourceDependenciesRequirements.Full => productProperties.SourceDependencies,
                 _ => throw new ArgumentOutOfRangeException()
             }
diff --git a/src/PostSharp.Engineering.BuildTools/ContinuousIntegration/Model/SourceDependenciesRequirements.cs b/src/PostSharp.Engineering.BuildTools/ContinuousIntegration/Model/SourceDependenciesRequirements.cs
@@ -0,0 +1,14 @@
+// Copyright (c) SharpCrafters s.r.o. See the LICENSE.md file in the root directory of this repository root for details.
+
+using System;
+
+namespace PostSharp.Engineering.BuildTools.ContinuousIntegration.Model;
+
+public enum SourceDependenciesRequirements
+{
+    None,
+    Full,
+
+    [Obsolete( "This does not work (not compatible with agent-side checkout)." )]
+    EngOnly
+}
diff --git a/src/PostSharp.Engineering.BuildTools/ContinuousIntegration/TeamCity/Generation/ProductProperties.cs b/src/PostSharp.Engineering.BuildTools/ContinuousIntegration/TeamCity/Generation/ProductProperties.cs
@@ -32,7 +32,7 @@ internal class ProductProperties
 
     public TeamCitySourceDependency[] SourceDependencies { get; }
 
-    public TeamCitySourceDependency[] EngOnlySourceDependencies { get; set; }
+    public TeamCitySourceDependency[] EngOnlySourceDependencies { get; }
 
     public ProductProperties( Product product )
     {
@@ -51,15 +51,24 @@ public ProductProperties( Product product )
                                                                          $"+:. => {product.SourceDependenciesDirectory}/{d.Name}" ) )
             .ToArray();
 
-        this.EngOnlySourceDependencies = product.SourceDependencies.Select( d => new TeamCitySourceDependency(
-                                                                                d.CiConfiguration.ProjectId.ToString(),
-                                                                                TeamCityHelper.GetVcsId( d ),
-                                                                                true,
-                                                                                $"""
-                                                                                 +:{product.DependencyDefinition.EngineeringDirectory} => {product.SourceDependenciesDirectory}/{d.Name}/{product.DependencyDefinition.EngineeringDirectory}
-                                                                                 +:DockerBuild.ps1 => {product.SourceDependenciesDirectory}/{d.Name}/DockerBuild.ps1
-                                                                                 +:Build.ps1 => {product.SourceDependenciesDirectory}/{d.Name}/Build.ps1
-                                                                                 """ ) )
+        this.EngOnlySourceDependencies = product.SourceDependencies.Select( d =>
+            {
+                var checkoutRules = $"""
+                                     +:{d.EngineeringDirectory} => {product.SourceDependenciesDirectory}/{d.Name}/{d.EngineeringDirectory}
+                                     +:DockerBuild.ps1 => {product.SourceDependenciesDirectory}/{d.Name}/DockerBuild.ps1
+                                     +:Build.ps1 => {product.SourceDependenciesDirectory}/{d.Name}/Build.ps1
+                                     """ +
+                                    Environment.NewLine +
+                                    string.Join(
+                                        Environment.NewLine,
+                                        d.AdditionalEngineeringDirectories.Select( x => $"+{x} => {product.SourceDependenciesDirectory}/{d.Name}/{x}" ) );
+
+                return new TeamCitySourceDependency(
+                    d.CiConfiguration.ProjectId.ToString(),
+                    TeamCityHelper.GetVcsId( d ),
+                    true,
+                    checkoutRules );
+            } )
             .ToArray();
     }
 }
diff --git a/src/PostSharp.Engineering.BuildTools/ContinuousIntegration/TeamCity/TeamCityBuildConfiguration.cs b/src/PostSharp.Engineering.BuildTools/ContinuousIntegration/TeamCity/TeamCityBuildConfiguration.cs
@@ -161,7 +161,8 @@ void AddBuildStep( BuildStep newStep )
                 }
             }
 
-            writer.WriteLine( $@"    }}" );
+            writer.WriteLine( "     checkoutMode = CheckoutMode.ON_AGENT" );
+            writer.WriteLine( @"    }" );
 
             // Build steps.
             if ( allBuildSteps.Count > 0 )
diff --git a/src/PostSharp.Engineering.BuildTools/Dependencies/Definitions/MetalamaDependencies.V2025_1.cs b/src/PostSharp.Engineering.BuildTools/Dependencies/Definitions/MetalamaDependencies.V2025_1.cs
@@ -68,10 +68,12 @@ public MetalamaDependencyDefinition(
                 MetalamaGitHubOrganization.Metalama )
             {
                 EngineeringDirectory = "eng-Metalama",
+                AdditionalEngineeringDirectories = ["eng"],
+
 #pragma warning disable CS0618 // Type or member is obsolete
                 ParametricPrivateArtifactsDirectory = Path.Combine( "artifacts", "packages", "$(MSBuildConfiguration)", "Shipping" ),
-                Dependencies = [DevelopmentDependencies.PostSharpEngineering]
 #pragma warning restore CS0618 // Type or member is obsolete
+                Dependencies = [DevelopmentDependencies.PostSharpEngineering]
             };
 
         public static DependencyDefinition Metalama { get; } =
@@ -200,10 +202,7 @@ public MetalamaDependencyDefinition(
                 MetalamaGitHubOrganization.Metalama,
                 false,
                 parentCiProjectId: $"Metalama_Metalama{Family.VersionWithoutDots}_MetalamaTests",
-                vcsRootProjectId: $"Metalama_Metalama{Family.VersionWithoutDots}" )
-            {
-                Dependencies = [DevelopmentDependencies.PostSharpEngineering, Metalama]
-            };
+                vcsRootProjectId: $"Metalama_Metalama{Family.VersionWithoutDots}" ) { Dependencies = [DevelopmentDependencies.PostSharpEngineering, Metalama] };
 
         public static DependencyDefinition MetalamaPerformance { get; } =
             new MetalamaDependencyDefinition(
diff --git a/src/PostSharp.Engineering.BuildTools/Dependencies/Definitions/MetalamaDependencies.V2025_2.cs b/src/PostSharp.Engineering.BuildTools/Dependencies/Definitions/MetalamaDependencies.V2025_2.cs
@@ -67,6 +67,7 @@ public MetalamaDependencyDefinition(
                 MetalamaGitHubOrganization.Metalama )
             {
                 EngineeringDirectory = "eng-Metalama",
+                AdditionalEngineeringDirectories = ["eng"],
 #pragma warning disable CS0618 // Type or member is obsolete
                 ParametricPrivateArtifactsDirectory = Path.Combine( "artifacts", "packages", "$(MSBuildConfiguration)", "Shipping" ),
 #pragma warning restore CS0618 // Type or member is obsolete
@@ -199,10 +200,7 @@ public MetalamaDependencyDefinition(
                 MetalamaGitHubOrganization.Metalama,
                 false,
                 parentCiProjectId: $"Metalama_Metalama{Family.VersionWithoutDots}_MetalamaTests",
-                vcsRootProjectId: $"Metalama_Metalama{Family.VersionWithoutDots}" )
-            {
-                Dependencies = [DevelopmentDependencies.PostSharpEngineering, Metalama]
-            };
+                vcsRootProjectId: $"Metalama_Metalama{Family.VersionWithoutDots}" ) { Dependencies = [DevelopmentDependencies.PostSharpEngineering, Metalama] };
 
         public static DependencyDefinition MetalamaPerformance { get; } =
             new MetalamaDependencyDefinition(
diff --git a/src/PostSharp.Engineering.BuildTools/Dependencies/Definitions/MetalamaDependencies.V2026_0.cs b/src/PostSharp.Engineering.BuildTools/Dependencies/Definitions/MetalamaDependencies.V2026_0.cs
@@ -69,6 +69,7 @@ public MetalamaDependencyDefinition(
                 MetalamaGitHubOrganization.Metalama )
             {
                 EngineeringDirectory = "eng-Metalama",
+                AdditionalEngineeringDirectories = ["eng"],
 #pragma warning disable CS0618 // Type or member is obsolete
                 ParametricPrivateArtifactsDirectory = Path.Combine( "artifacts", "packages", "$(MSBuildConfiguration)", "Shipping" ),
 #pragma warning restore CS0618 // Type or member is obsolete
@@ -201,10 +202,7 @@ public MetalamaDependencyDefinition(
                 MetalamaGitHubOrganization.Metalama,
                 false,
                 parentCiProjectId: $"Metalama_Metalama{Family.VersionWithoutDots}_MetalamaTests",
-                vcsRootProjectId: $"Metalama_Metalama{Family.VersionWithoutDots}" )
-            {
-                Dependencies = [DevelopmentDependencies.PostSharpEngineering, Metalama]
-            };
+                vcsRootProjectId: $"Metalama_Metalama{Family.VersionWithoutDots}" ) { Dependencies = [DevelopmentDependencies.PostSharpEngineering, Metalama] };
 
         public static DependencyDefinition MetalamaPerformance { get; } =
             new MetalamaDependencyDefinition(
diff --git a/src/PostSharp.Engineering.BuildTools/Dependencies/Model/DependencyDefinition.cs b/src/PostSharp.Engineering.BuildTools/Dependencies/Model/DependencyDefinition.cs
@@ -4,6 +4,7 @@
 using PostSharp.Engineering.BuildTools.Build;
 using PostSharp.Engineering.BuildTools.Build.Model;
 using PostSharp.Engineering.BuildTools.ContinuousIntegration;
+using PostSharp.Engineering.BuildTools.ContinuousIntegration.Model;
 using System;
 using System.Collections.Generic;
 using System.Diagnostics.CodeAnalysis;
@@ -58,6 +59,12 @@ public class DependencyDefinition
 
         public string EngineeringDirectory { get; init; } = "eng";
 
+        /// <summary>
+        /// Gets or set the list of other directories (additionally to <see cref="EngineeringDirectory"/>) that should
+        /// be checked out when <see cref="SourceDependenciesRequirements.EngOnly"/> is specified. 
+        /// </summary>
+        public string[] AdditionalEngineeringDirectories { get; init; } = [];
+
         public string CodeStyle { get; init; } = "Standard";
 
         public VcsRepository VcsRepository { get; }

Original file line number	Diff line number	Diff line change
`@@ -45,7 +45,9 @@ internal override TeamCityBuildConfiguration TeamCityBuildConfiguration( Product`
`45`	`45`	`SourceDependencies = this.SourceDependenciesRequirements switch`
`46`	`46`	`{`
`47`	`47`	`SourceDependenciesRequirements.None => [],`
	`48`	`+#pragma warning disable CS0618 // Type or member is obsolete`
`48`	`49`	`SourceDependenciesRequirements.EngOnly => productProperties.EngOnlySourceDependencies,`
	`50`	`+#pragma warning restore CS0618 // Type or member is obsolete`
`49`	`51`	`SourceDependenciesRequirements.Full => productProperties.SourceDependencies,`
`50`	`52`	`_ => throw new ArgumentOutOfRangeException()`
`51`	`53`	`}`
Original file line number	Diff line number	Diff line change
`@@ -161,7 +161,8 @@ void AddBuildStep( BuildStep newStep )`
`161`	`161`	`}`
`162`	`162`	`}`
`163`	`163`
`164`		`- writer.WriteLine( $@" }}" );`
	`164`	`+ writer.WriteLine( " checkoutMode = CheckoutMode.ON_AGENT" );`
	`165`	`+ writer.WriteLine( @" }" );`
`165`	`166`
`166`	`167`	`// Build steps.`
`167`	`168`	`if ( allBuildSteps.Count > 0 )`