Commit build changes [ci skip]

MathieuBuisson · Jun 18, 2017 · 6556034 · 6556034
1 parent 07ae506
commit 6556034
Show file tree

Hide file tree

Showing 4 changed files with 56 additions and 1 deletion.
diff --git a/PSCodeHealth/PSCodeHealth.psd1 b/PSCodeHealth/PSCodeHealth.psd1
@@ -12,7 +12,7 @@
 RootModule = '.\PSCodeHealth.psm1'
 
 # Version number of this module.
-ModuleVersion = '0.1.137'
+ModuleVersion = '0.1.138'
 
 # ID used to uniquely identify this module
 GUID = 'ca22dabd-bbb6-4805-9c90-a8aad6dbbfd3'

diff --git a/docs/InternalFunctions/New-FailedTestsInfo.md b/docs/InternalFunctions/New-FailedTestsInfo.md
@@ -0,0 +1,53 @@
+# New-FailedTestsInfo
+
+## SYNOPSIS
+Creates one or more custom objects of the type : 'PSCodeHealth.Overall.FailedTestsInfo'.
+
+## SYNTAX
+
+```
+New-FailedTestsInfo [-TestsResult] <PSObject>
+```
+
+## DESCRIPTION
+Creates one or more custom objects of the type : 'PSCodeHealth.Overall.FailedTestsInfo'.
+
+This outputs an object containing key information about each failed test.
+This information is used in the overall health report.
+
+## EXAMPLES
+
+### -------------------------- EXAMPLE 1 --------------------------
+```
+New-FailedTestsInfo -TestsResult $TestsResult
+```
+
+Returns a new custom object of the type 'PSCodeHealth.Overall.FailedTestsInfo' for each failed test in the input $TestsResult.
+
+## PARAMETERS
+
+### -TestsResult
+To specify the Pester tests result object.
+
+```yaml
+Type: PSObject
+Parameter Sets: (All)
+Aliases: 
+
+Required: True
+Position: 1
+Default value: None
+Accept pipeline input: False
+Accept wildcard characters: False
+```
+
+## INPUTS
+
+## OUTPUTS
+
+### PSCodeHealth.Overall.FailedTestsInfo
+
+## NOTES
+
+## RELATED LINKS
+
diff --git a/docs/InternalFunctions/New-PSCodeHealthReport.md b/docs/InternalFunctions/New-PSCodeHealthReport.md
@@ -110,6 +110,7 @@ Accept wildcard characters: False
 To use an existing Pester tests result object for generating the following metrics :  
   - NumberOfTests  
   - NumberOfFailedTests  
+  - FailedTestsDetails  
   - NumberOfPassedTests  
   - TestsPassRate (%)  
   - TestCoverage (%)  

diff --git a/mkdocs.yml b/mkdocs.yml
@@ -18,6 +18,7 @@ pages:
   - Internal Functions:
     - Get-PowerShellFile: InternalFunctions/Get-PowerShellFile.md
     - Merge-PSCodeHealthSetting: InternalFunctions/Merge-PSCodeHealthSetting.md
+    - New-FailedTestsInfo: InternalFunctions/New-FailedTestsInfo.md
     - New-FunctionHealthRecord: InternalFunctions/New-FunctionHealthRecord.md
     - New-PSCodeHealthComplianceResult: InternalFunctions/New-PSCodeHealthComplianceResult.md
     - New-PSCodeHealthComplianceRule: InternalFunctions/New-PSCodeHealthComplianceRule.md