#567: Added report type: MarkdownSummaryGithub

danielpalme · Dec 8, 2022 · e223c26 · e223c26
1 parent a07f9b3
commit e223c26
Show file tree

Hide file tree

Showing 13 changed files with 350 additions and 32 deletions.
diff --git a/README.md b/README.md
@@ -69,7 +69,7 @@ Explanations:
    Target directory:   The directory where the generated report should be saved.
    Report types:       The output formats and scope (separated by semicolon).
                        Values: Badges, Clover, Cobertura, CsvSummary, 
-                       MarkdownSummary, MarkdownDeltaSummary
+                       MarkdownSummary, MarkdownSummaryGithub, MarkdownDeltaSummary
                        Html, Html_Light, Html_Dark,
                        HtmlChart, HtmlInline, HtmlSummary,
                        HtmlInline_AzurePipelines, HtmlInline_AzurePipelines_Light, HtmlInline_AzurePipelines_Dark,

diff --git a/docs/404.html b/docs/404.html
@@ -22,5 +22,5 @@
       h.appendChild(s);
     }
  </script>
-<script src="runtime.3a967657a38b0761.js" type="module"></script><script src="polyfills.9a22b7af111a7897.js" type="module"></script><script src="scripts.58e82174560aba06.js" defer></script><script src="main.021491a4ae3ce5c3.js" type="module"></script>
+<script src="runtime.3a967657a38b0761.js" type="module"></script><script src="polyfills.9a22b7af111a7897.js" type="module"></script><script src="scripts.58e82174560aba06.js" defer></script><script src="main.09ab324871208d92.js" type="module"></script>
 </body></html>
diff --git a/docs/index.html b/docs/index.html
@@ -22,5 +22,5 @@
       h.appendChild(s);
     }
  </script>
-<script src="runtime.3a967657a38b0761.js" type="module"></script><script src="polyfills.9a22b7af111a7897.js" type="module"></script><script src="scripts.58e82174560aba06.js" defer></script><script src="main.021491a4ae3ce5c3.js" type="module"></script>
+<script src="runtime.3a967657a38b0761.js" type="module"></script><script src="polyfills.9a22b7af111a7897.js" type="module"></script><script src="scripts.58e82174560aba06.js" defer></script><script src="main.09ab324871208d92.js" type="module"></script>
 </body></html>
diff --git a/docs/main.021491a4ae3ce5c3.js → docs/main.09ab324871208d92.js b/docs/main.021491a4ae3ce5c3.js → docs/main.09ab324871208d92.js
diff --git a/docs/resources/SampleReports.zip b/docs/resources/SampleReports.zip
diff --git a/src/AzureDevopsTask/README.md b/src/AzureDevopsTask/README.md
@@ -18,7 +18,7 @@ To learn how to use *ReportGenerator* have a look at the:
   inputs:
     reports: 'coverage.xml' # REQUIRED # The coverage reports that should be parsed (separated by semicolon). Globbing is supported.
     targetdir: 'coveragereport' # REQUIRED # The directory where the generated report should be saved.
-    reporttypes: 'HtmlInline_AzurePipelines;Cobertura' # The output formats and scope (separated by semicolon) Values: Badges, Clover, Cobertura, CsvSummary, Html, Html_Dark, Html_Light, HtmlChart, HtmlInline, HtmlInline_AzurePipelines, HtmlInline_AzurePipelines_Dark, HtmlInline_AzurePipelines_Light, HtmlSummary, JsonSummary, Latex, LatexSummary, lcov, MarkdownSummary, MarkdownDeltaSummary, MHtml, PngChart, SonarQube, TeamCitySummary, TextSummary, TextDeltaSummary, Xml, XmlSummary
+    reporttypes: 'HtmlInline_AzurePipelines;Cobertura' # The output formats and scope (separated by semicolon) Values: Badges, Clover, Cobertura, CsvSummary, Html, Html_Dark, Html_Light, HtmlChart, HtmlInline, HtmlInline_AzurePipelines, HtmlInline_AzurePipelines_Dark, HtmlInline_AzurePipelines_Light, HtmlSummary, JsonSummary, Latex, LatexSummary, lcov, MarkdownSummary, MarkdownSummaryGithub, MarkdownDeltaSummary, MHtml, PngChart, SonarQube, TeamCitySummary, TextSummary, TextDeltaSummary, Xml, XmlSummary
     sourcedirs: '' # Optional directories which contain the corresponding source code (separated by semicolon). The source directories are used if coverage report contains classes without path information.
     historydir: '' # Optional directory for storing persistent coverage information. Can be used in future reports to show coverage evolution.
     plugins: '' # Optional plugin files for custom reports or custom history storage (separated by semicolon).

diff --git a/src/AzureDevopsTask/ReportGenerator/task.json b/src/AzureDevopsTask/ReportGenerator/task.json
@@ -41,7 +41,7 @@
             "label": "Report types",
             "defaultValue": "HtmlInline_AzurePipelines;Cobertura",
             "required": false,
-            "helpMarkDown": "The output formats and scope (separated by semicolon) Values: Badges, Clover, Cobertura, CsvSummary, Html, Html_Dark, Html_Light, HtmlChart, HtmlInline, HtmlInline_AzurePipelines, HtmlInline_AzurePipelines_Dark, HtmlInline_AzurePipelines_Light, HtmlSummary, JsonSummary, Latex, LatexSummary, lcov, MarkdownSummary, MarkdownDeltaSummary, MHtml, PngChart, SonarQube, TeamCitySummary, TextSummary, TextDeltaSummary, Xml, XmlSummary"
+            "helpMarkDown": "The output formats and scope (separated by semicolon) Values: Badges, Clover, Cobertura, CsvSummary, Html, Html_Dark, Html_Light, HtmlChart, HtmlInline, HtmlInline_AzurePipelines, HtmlInline_AzurePipelines_Dark, HtmlInline_AzurePipelines_Light, HtmlSummary, JsonSummary, Latex, LatexSummary, lcov, MarkdownSummary, MarkdownSummaryGithub, MarkdownDeltaSummary, MHtml, PngChart, SonarQube, TeamCitySummary, TextSummary, TextDeltaSummary, Xml, XmlSummary"
         },
         {
             "name": "sourcedirs",

diff --git a/src/Readme.txt b/src/Readme.txt
@@ -35,7 +35,7 @@ The following output formats are supported by ReportGenerator:
 -TeamCitySummary
 -TextSummary, TextDeltaSummary
 -CsvSummary
--MarkdownSummary, MarkdownDeltaSummary
+-MarkdownSummary, MarkdownSummaryGithub, MarkdownDeltaSummary
 -PngChart
 -Badges
 -Custom formats (https://github.com/danielpalme/ReportGenerator/wiki/Custom-reports)
@@ -67,6 +67,10 @@ For further details take a look at LICENSE.txt.
 
 CHANGELOG
 
+5.1.13.0
+
+    * New: #567: Added report type: MarkdownSummaryGithub
+
 5.1.12.0
 
     * Fix: #548: Improved handling of OverflowException

diff --git a/src/ReportGenerator.Core/Properties/ReportResources.Designer.cs b/src/ReportGenerator.Core/Properties/ReportResources.Designer.cs
diff --git a/src/ReportGenerator.Core/Properties/ReportResources.resx b/src/ReportGenerator.Core/Properties/ReportResources.resx
@@ -399,4 +399,7 @@
   <data name="Previous" xml:space="preserve">
     <value>Previous</value>
   </data>
+  <data name="Branch" xml:space="preserve">
+    <value>Branch</value>
+  </data>
 </root>
diff --git a/src/ReportGenerator.Core/Reporting/Builders/MarkdownDeltaSummaryReportBuilder.cs b/src/ReportGenerator.Core/Reporting/Builders/MarkdownDeltaSummaryReportBuilder.cs
@@ -3,8 +3,8 @@
 using System.Globalization;
 using System.IO;
 using System.Linq;
-using System.Text;
 using Palmmedia.ReportGenerator.Core.Common;
+using Palmmedia.ReportGenerator.Core.Licensing;
 using Palmmedia.ReportGenerator.Core.Logging;
 using Palmmedia.ReportGenerator.Core.Parser.Analysis;
 using Palmmedia.ReportGenerator.Core.Properties;
@@ -92,6 +92,8 @@ public void CreateSummaryReport(SummaryResult summaryResult)
 
             Logger.InfoFormat(Resources.WritingReportFile, targetPath);
 
+            bool proVersion = this.ReportContext.ReportConfiguration.License.DetermineLicenseType() == LicenseType.Pro;
+
             using (var reportTextWriter = File.CreateText(targetPath))
             {
                 HistoricCoverage previous = historicCoverages[0];
@@ -118,9 +120,17 @@ public void CreateSummaryReport(SummaryResult summaryResult)
                 reportTextWriter.WriteLine("| **{0}** | {1} |", ReportResources.BranchCoverage2, this.ReportCoverageQuota(previous.BranchCoverageQuota, current.BranchCoverageQuota));
                 reportTextWriter.WriteLine("| {0} | {1} |", ReportResources.CoveredBranches2, this.ReportValues(previous.CoveredBranches, current.CoveredBranches));
                 reportTextWriter.WriteLine("| {0} | {1} |", ReportResources.TotalBranches, this.ReportValues(previous.TotalBranches, current.TotalBranches));
-                reportTextWriter.WriteLine("| **{0}** | {1} |", ReportResources.CodeElementCoverageQuota2, this.ReportCoverageQuota(previous.CodeElementCoverageQuota, current.CodeElementCoverageQuota));
-                reportTextWriter.WriteLine("| {0} | {1} |", ReportResources.CoveredCodeElements, this.ReportValues(previous.CoveredCodeElements, current.CoveredCodeElements));
-                reportTextWriter.WriteLine("| {0} | {1} |", ReportResources.TotalCodeElements, this.ReportValues(previous.TotalCodeElements, current.TotalCodeElements));
+
+                if (proVersion)
+                {
+                    reportTextWriter.WriteLine("| **{0}** | {1} |", ReportResources.CodeElementCoverageQuota2, this.ReportCoverageQuota(previous.CodeElementCoverageQuota, current.CodeElementCoverageQuota));
+                    reportTextWriter.WriteLine("| {0} | {1} |", ReportResources.CoveredCodeElements, this.ReportValues(previous.CoveredCodeElements, current.CoveredCodeElements));
+                    reportTextWriter.WriteLine("| {0} | {1} |", ReportResources.TotalCodeElements, this.ReportValues(previous.TotalCodeElements, current.TotalCodeElements));
+                }
+                else
+                {
+                    reportTextWriter.WriteLine("| **{0}** | [{1}](https://reportgenerator.io/pro) |", ReportResources.CodeElementCoverageQuota2, ReportResources.MethodCoverageProVersion);
+                }
 
                 reportTextWriter.Flush();
             }