Refactoring of the documentation updater. Propagating the --no-sign flag to dotnet build.

Author: gfraiteur

src/PostSharp.Engineering.BuildTools/AppExtensions.cs

@@ -51,6 +51,8 @@ public Product( DependencyDefinition dependencyDefinition )
             this.DockerBaseImage = dependencyDefinition.ProductFamily.DockerBaseImage;
         }
 
+        public bool AddDefaultCommands { get; init; } = true;
+
         public ProductFamily ProductFamily => this.DependencyDefinition.ProductFamily;
 
         public string BuildExePath { get; }
@@ -215,7 +217,7 @@ public ParametrizedDependency[] ParametrizedDependencies
         public DockerImageComponent[] AdditionalDockerImageComponents { get; init; } = [];
 
         public bool UseDockerInTeamcity { get; init; }
-        
+
         public bool IsPublishingNonReleaseBranchesAllowed { get; init; }
 
         public bool TryGetDependency( string name, [NotNullWhen( true )] out ParametrizedDependency? dependency )
@@ -676,7 +678,7 @@ public bool TryReadMainVersionFile(
             BuildContext context,
             [NotNullWhen( true )] out MainVersionFileInfo? mainVersionFileInfo )
             => this.TryReadMainVersionFile( context, out mainVersionFileInfo, out _ );
-        
+
         /// <summary>
         /// Reads MainVersion.props but does not interpret anything.
         /// </summary>
@@ -732,7 +734,7 @@ public bool TryReadMainVersionFile(
 
             ProjectCollection.GlobalProjectCollection.UnloadAllProjects();
 
-            mainVersionFileInfo = new(
+            mainVersionFileInfo = new MainVersionFileInfo(
                 mainVersion,
                 overriddenPatchVersion,
                 suffix,
@@ -1367,7 +1369,7 @@ private bool TryGenerateManifestFileContent(
             out string manifestFileContent )
         {
             var success = true;
-            
+
             manifestFileContent = $@"
 <!-- File generated by PostSharp.Engineering {VersionHelper.EngineeringVersion}, method {nameof(Product)}.{nameof(this.TryGenerateManifestFileContent)}. -->
 <Project>
@@ -1596,11 +1598,11 @@ void CleanNugetCache()
                     foreach ( var subDir in dir.EnumerateDirectories() )
                     {
                         var directoryPath = Path.Combine( nugetCacheDirectory, dir.Name, subDir.Name );
-                        
+
                         if ( subDir.Name.Equals( VersionHelper.EngineeringVersion, StringComparison.OrdinalIgnoreCase ) )
                         {
                             context.Console.WriteMessage( $"Skipping directory '{directoryPath}'." );
-                            
+
                             continue;
                         }
 
@@ -1764,7 +1766,7 @@ public bool PrePublish( BuildContext context, PublishSettings settings )
             {
                 return false;
             }
-            
+
             if ( TeamCityHelper.IsTeamCityBuild( settings ) )
             {
                 // When on TeamCity, Git user credentials are set to TeamCity.
@@ -1792,19 +1794,19 @@ public bool PrePublish( BuildContext context, PublishSettings settings )
 
                 return false;
             }
-            
+
             if ( !TryUpdateAutoUpdatedDependencies( context, settings ) )
             {
                 context.Console.WriteError( "Failed to update auto-updated dependencies." );
-                
+
                 return false;
             }
-            
+
             if ( !GitHelper.TryPullAndMergeAndPush( context, settings, targetBranch ) )
             {
                 return false;
             }
-            
+
             // Act as a local dependency for subsequent projects, that use the --use-local-dependencies flag.
             this.WriteImportFile( context, settings.BuildConfiguration );
 
@@ -1818,7 +1820,7 @@ public bool Publish( BuildContext context, PublishSettings settings )
             if ( !context.Product.IsPublishingNonReleaseBranchesAllowed && !settings.IsStandalone )
             {
                 var publishingBranch = context.Product.DependencyDefinition.PublishingBranch;
-                
+
                 if ( context.Branch != publishingBranch )
                 {
                     context.Console.WriteError(
@@ -1837,7 +1839,7 @@ public bool Publish( BuildContext context, PublishSettings settings )
             {
                 return false;
             }
-            
+
             // TODO: Verification is broken - NuGet verification is slow and makes the verification fail
             // on seemimngly unpublished packages.
             // if ( settings.BuildConfiguration == BuildConfiguration.Public )
@@ -1853,7 +1855,7 @@ public bool Publish( BuildContext context, PublishSettings settings )
             var directories = this.GetArtifactsDirectories( context, buildInfo );
             var configurationInfo = this.Configurations.GetValue( configuration );
             var hasTarget = false;
-            
+
             if ( !Publisher.PublishDirectory(
                     context,
                     settings,
@@ -1889,7 +1891,7 @@ public bool Publish( BuildContext context, PublishSettings settings )
                         return false;
                     }
                 }
-                
+
                 if ( !this.TryAddTagToLastCommit( context, settings ) )
                 {
                     context.Console.WriteError( "Failed to tag the latest commit." );
@@ -1942,12 +1944,12 @@ public bool Publish( BuildContext context, PublishSettings settings )
         public bool PostPublish( BuildContext context, PublishSettings settings )
         {
             context.Console.WriteHeading( "Finishing publishing." );
-            
+
             if ( !this.PrepareVersionsFile( context, settings, out _ ) )
             {
                 return false;
             }
-            
+
             if ( TeamCityHelper.IsTeamCityBuild( settings ) )
             {
                 // When on TeamCity, Git user credentials are set to TeamCity.
@@ -1956,7 +1958,7 @@ public bool PostPublish( BuildContext context, PublishSettings settings )
                     return false;
                 }
             }
-            
+
             var sourceBranch = context.Product.DependencyDefinition.ReleaseBranch;
 
             if ( sourceBranch == null )
@@ -1965,7 +1967,7 @@ public bool PostPublish( BuildContext context, PublishSettings settings )
 
                 return false;
             }
-            
+
             if ( context.Branch != sourceBranch )
             {
                 context.Console.WriteError(
@@ -1977,10 +1979,10 @@ public bool PostPublish( BuildContext context, PublishSettings settings )
             if ( !this.TryAddTagToLastCommit( context, settings ) )
             {
                 context.Console.WriteError( "Failed to tag the latest commit." );
-                
+
                 return false;
             }
-            
+
             // Merge the release branch back to develop branch.
             if ( !GitHelper.TryPullAndMergeAndPush( context, settings, context.Product.DependencyDefinition.Branch ) )
             {
@@ -1989,7 +1991,7 @@ public bool PostPublish( BuildContext context, PublishSettings settings )
 
             // Act as a local dependency for subsequent projects, that use the --use-local-dependencies flag.
             this.WriteImportFile( context, settings.BuildConfiguration );
-            
+
             context.Console.WriteSuccess( "Publishing finished successfuly." );
 
             return true;
@@ -2305,7 +2307,7 @@ private bool TryReadDependencyVersionsFromSourceRepos(
                 }
 
                 var mainVersionFile = $"{dependency.EngineeringDirectory}/MainVersion.props";
-                
+
                 if ( !dependency.VcsRepository.TryDownloadTextFile( context.Console, dependency.Branch, mainVersionFile, out var mainVersionContent ) )
                 {
                     return false;
@@ -2446,10 +2448,11 @@ internal bool GenerateTeamcityConfiguration( BuildContext context, CommonCommand
                 }
 
                 teamCityBuildSteps.Add( new TeamCityEngineeringBuildBuildStep( configuration, true, this.UseDockerInTeamcity ) );
-                
+
                 if ( !this.UseDockerInTeamcity )
                 {
-                    teamCityBuildSteps.Add( new TeamCityEngineeringCommandBuildStep( "PostKill", "Kill background processes before next build", "tools kill" ) );
+                    teamCityBuildSteps.Add(
+                        new TeamCityEngineeringCommandBuildStep( "PostKill", "Kill background processes before next build", "tools kill" ) );
                 }
 
                 // The default branch for the public build cannot be set to the release branch,
@@ -2641,7 +2644,7 @@ [new TeamCityEngineeringCommandBuildStep( "Bump", "Bump", "bump", areCustomArgum
                     return false;
                 }
             }
-            
+
             var teamCityProject = new TeamCityProject( teamCityBuildConfigurations.ToArray() );
 
             TeamCityHelper.GeneratePom( context, this.DependencyDefinition.CiConfiguration.ProjectId.Id, this.DependencyDefinition.CiConfiguration.BaseUrl );
@@ -2775,7 +2778,7 @@ private bool TryAddTagToLastCommit( BuildContext context, PublishSettings settin
             {
                 return false;
             }
-            
+
             var versionTag = string.Concat( "release/", preparedVersionInfo.Version, preparedVersionInfo.PackageVersionSuffix );
 
             ToolInvocationHelper.InvokeTool(

src/PostSharp.Engineering.BuildTools/Build/Model/Product.cs

@@ -1,4 +1,6 @@
-using PostSharp.Engineering.BuildTools.ContinuousIntegration.Model;
+// Copyright (c) SharpCrafters s.r.o. See the LICENSE.md file in the root directory of this repository root for details.
+
+using PostSharp.Engineering.BuildTools.ContinuousIntegration.Model;
 using Spectre.Console.Cli;
 using System.Collections.Generic;
 
@@ -8,5 +10,5 @@ public abstract class ProductExtension
 {
     internal abstract bool AddTeamcityBuildConfiguration( BuildContext context, List<TeamCityBuildConfiguration> teamCityBuildConfigurations );
 
-    internal abstract bool AddTool( IConfigurator<CommandSettings> tools );
+    internal abstract bool AddCommands( IConfigurator root, BaseCommandData data );
 }

src/PostSharp.Engineering.BuildTools/Build/Model/ProductExtension.cs

@@ -9,11 +9,11 @@
 
 namespace PostSharp.Engineering.BuildTools.Search.Backends;
 
-public class ConsoleBackend : SearchBackendBase
+public class DrySearchBackend : SearchBackendBase
 {
     private readonly ConsoleHelper _console;
 
-    public ConsoleBackend( ConsoleHelper console )
+    public DrySearchBackend( ConsoleHelper console )
     {
         this._console = console;
     }
@@ -26,14 +26,14 @@ public override Task CreateCollectionAsync( Schema schema )
         {
             this._console.WriteMessage( $"  {field.Name}: {field.Type}, facet: {field.Facet}" );
         }
-        
+
         this._console.WriteMessage( "" );
 
         return Task.CompletedTask;
     }
 
     public override Task DeleteCollectionAsync( string collection ) => throw new NotSupportedException();
-    
+
     public override Task<bool> TryDeleteCollectionAsync( string collection ) => Task.FromResult( false );
 
     public override Task<IEnumerable<CollectionResponse>> RetrieveCollectionsAsync() => throw new NotSupportedException();
@@ -49,7 +49,7 @@ public override Task CreateCollectionAsync( Schema schema )
     private void WriteObject( object o, int indentation = 0 )
     {
         var indentationString = new string( ' ', indentation );
-        
+
         foreach ( var property in o.GetType().GetProperties() )
         {
             var value = property.GetValue( o )!;

…dTools/Search/Backends/ConsoleBackend.cs …ools/Search/Backends/DrySearchBackend.cssrc/PostSharp.Engineering.BuildTools/Search/Backends/ConsoleBackend.cs renamed to src/PostSharp.Engineering.BuildTools/Search/Backends/DrySearchBackend.cs src/PostSharp.Engineering.BuildTools/Search/Backends/ConsoleBackend.cs renamed to src/PostSharp.Engineering.BuildTools/Search/Backends/DrySearchBackend.cs

@@ -6,7 +6,7 @@
 
 namespace PostSharp.Engineering.BuildTools.Search.Crawlers;
 
-public static class DocFxApiArticleHelper
+internal static class DocFxApiArticleHelper
 {
     public static NextParagraphStrategy GetNextParagraphStrategy( HtmlNode paragraphInitialNode )
     {
@@ -48,7 +48,7 @@ public static NextParagraphStrategy GetNextParagraphStrategy( HtmlNode paragraph
                 }
 
                 break;
-            
+
             case 5:
                 var text = paragraphInitialNode.GetText().Trim();
                 isIgnored = text != "Remarks";