Added support for markdown output format #114 (#115)

microsoft · Feb 4, 2021 · 6a65586 · 6a65586
1 parent 06ad373
commit 6a65586
Show file tree

Hide file tree

Showing 4 changed files with 11 additions and 9 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -12,6 +12,7 @@ What's changed since v0.7.0:
   - Added support for using baselines. [#46](https://github.com/microsoft/PSRule-pipelines/issues/46)
     - Specify a named baseline by using `baseline: '<baseline_name>'`.
     - Baselines can be included from individual files or modules using `source:` and `modules:`.
+  - Added support for markdown output format. [#114](https://github.com/microsoft/PSRule-pipelines/issues/114)
 - Engineering:
   - Bump PSRule dependency to v1.0.1. [#106](https://github.com/microsoft/PSRule-pipelines/issues/106)
     - See the [change log](https://github.com/microsoft/PSRule/blob/main/docs/CHANGELOG-v1.md#v101)

diff --git a/docs/tasks.md b/docs/tasks.md
@@ -48,14 +48,14 @@ Syntax:
 steps:
 - task: ps-rule-assert@0
   inputs:
-    inputType: repository, inputPath              # Required. Determines the type of input to use for PSRule.
-    inputPath: string                             # Required. The path PSRule will look for files to validate.
-    modules: string                               # Optional. A comma separated list of modules to use for analysis.
-    baseline: string                              # Optional. The name of a PSRule baseline to use.
-    source: string                                # Optional. An path containing rules to use for analysis.
-    outputFormat: None, Yaml, Json, NUnit3, Csv   # Optional. The format to use when writing results to disk.
-    outputPath: string                            # Optional. The file path to write results to.
-    path: string                                  # Optional. The working directory PSRule is run from.
+    inputType: repository, inputPath                        # Required. Determines the type of input to use for PSRule.
+    inputPath: string                                       # Required. The path PSRule will look for files to validate.
+    modules: string                                         # Optional. A comma separated list of modules to use for analysis.
+    baseline: string                                        # Optional. The name of a PSRule baseline to use.
+    source: string                                          # Optional. An path containing rules to use for analysis.
+    outputFormat: None, Yaml, Json, Markdown, NUnit3, Csv   # Optional. The format to use when writing results to disk.
+    outputPath: string                                      # Optional. The file path to write results to.
+    path: string                                            # Optional. The working directory PSRule is run from.
 ```
 
 - **inputType**: Determines the type of input to use for PSRule.

diff --git a/tasks/ps-rule-assert/powershell.ps1 b/tasks/ps-rule-assert/powershell.ps1
@@ -36,7 +36,7 @@ param (
 
     # The output format
     [Parameter(Mandatory = $False)]
-    [ValidateSet('None', 'Yaml', 'Json', 'NUnit3', 'Csv')]
+    [ValidateSet('None', 'Yaml', 'Json', 'Markdown', 'NUnit3', 'Csv')]
     [String]$OutputFormat = (Get-VstsInput -Name 'outputFormat'),
 
     # The path to store formatted output

diff --git a/tasks/ps-rule-assert/task.json b/tasks/ps-rule-assert/task.json
@@ -93,6 +93,7 @@
                 "None": "None",
                 "Yaml": "Yaml",
                 "Json": "Json",
+                "Markdown": "Markdown",
                 "NUnit3": "NUnit3",
                 "Csv": "Csv"
             },