#651 Added setting to add custom prefix to generated history files

Author: danielpalme

src/Readme.txt

@@ -67,6 +67,10 @@ For further details take a look at LICENSE.txt.
 
 CHANGELOG
 
+5.2.2.0
+
+    * New: #651 Added setting to add custom prefix to generated history files
+
 5.2.1.0
 
     * New: Added 'Crap Score' metric for Coberatura coverage files (contrbuted by @rikrak)

src/ReportGenerator.Core/Generator.cs

@@ -328,7 +328,7 @@ public void GenerateReport(
 
             if (historyStorage != null)
             {
-                new HistoryReportGenerator(historyStorage)
+                new HistoryReportGenerator(historyStorage, settings.HistoryFileNamePrefix)
                     .CreateReport(parserResult.Assemblies, executionTime, reportConfiguration.Tag);
             }
 

src/ReportGenerator.Core/Reporting/History/HistoryReportGenerator.cs

@@ -28,13 +28,20 @@ internal class HistoryReportGenerator
         /// </summary>
         private readonly IHistoryStorage historyStorage;
 
+        /// <summary>
+        /// Optional custom file prefix.
+        /// </summary>
+        private readonly string customfilePrefix;
+
         /// <summary>
         /// Initializes a new instance of the <see cref="HistoryReportGenerator" /> class.
         /// </summary>
         /// <param name="historyStorage">The history storage.</param>
-        internal HistoryReportGenerator(IHistoryStorage historyStorage)
+        /// <param name="customfilePrefix">Optional custom file prefix.</param>
+        internal HistoryReportGenerator(IHistoryStorage historyStorage, string customfilePrefix)
         {
             this.historyStorage = historyStorage ?? throw new ArgumentNullException(nameof(historyStorage));
+            this.customfilePrefix = string.IsNullOrWhiteSpace(customfilePrefix) ? string.Empty : "_" + customfilePrefix;
         }
 
         /// <summary>
@@ -86,7 +93,7 @@ internal void CreateReport(IEnumerable<Assembly> assemblies, DateTime executionT
             }
 
             var document = new XDocument(new XDeclaration("1.0", "UTF-8", "yes"), rootElement);
-            string fileName = date + "_CoverageHistory.xml";
+            string fileName = date + this.customfilePrefix + "_CoverageHistory.xml";
             try
             {
                 using (var stream = new MemoryStream())

src/ReportGenerator.Core/Settings.cs

@@ -75,5 +75,10 @@ public int CachingDuringOfRemoteFilesInMinutes
         /// Gets or sets the maximum decimal places for coverage quotas / percentages.
         /// </summary>
         public int MaximumDecimalPlacesForCoverageQuotas { get; set; } = 1;
+
+        /// <summary>
+        /// Gets or sets the prefix for history files.
+        /// </summary>
+        public string HistoryFileNamePrefix { get; set; }
     }
 }

src/ReportGenerator.Core/appsettings.json

@@ -18,6 +18,8 @@
     "excludeTestProjects": false,
     "createSubdirectoryForAllReportTypes": false,
     "customHeadersForRemoteFiles": null,
-    "defaultAssemblyName": "Default"
+    "defaultAssemblyName": "Default",
+    "maximumDecimalPlacesForCoverageQuotas": 1,
+    "historyFileNamePrefix":  null
   }
 }