Updated documentation

pester · Jun 19, 2021 · c17260f · c17260f
1 parent b427daa
commit c17260f
Show file tree

Hide file tree

Showing 2 changed files with 2 additions and 2 deletions.
diff --git a/src/Pester.RSpec.ps1 b/src/Pester.RSpec.ps1
@@ -399,7 +399,7 @@ function New-PesterConfiguration {
       StackTraceVerbosity: The verbosity of stacktrace output, options are None, FirstLine, Filtered and Full.
       Default value: 'Filtered'
 
-      CIFormat: The CI format of output, options are None, Auto, AzureDevops and GithubActions.
+      CIFormat: The CI format of output in build logs, options are None, Auto, AzureDevops and GithubActions. Environment variable TF_BUILD(https://docs.microsoft.com/en-us/azure/devops/pipelines/build/variables?view=azure-devops&tabs=yaml#system-variables-devops-services) is automically set to true when Azure Devops is detected. Environment variable GITHUB_ACTIONS(https://docs.github.com/en/actions/reference/environment-variables#default-environment-variables) is automatically set to true when Github Actions is detected.
       Default value: 'Auto'
     ```
 

diff --git a/src/csharp/Pester/OutputConfiguration.cs b/src/csharp/Pester/OutputConfiguration.cs
@@ -46,7 +46,7 @@ public OutputConfiguration() : base("Output configuration")
         {
             Verbosity = new StringOption("The verbosity of output, options are None, Normal, Detailed and Diagnostic.", "Normal");
             StackTraceVerbosity = new StringOption("The verbosity of stacktrace output, options are None, FirstLine, Filtered and Full.", "Filtered");
-            CIFormat = new StringOption("The CI format of output, options are None, Auto, AzureDevops and GithubActions.", "Auto");
+            CIFormat = new StringOption("The CI format of output in build logs, options are None, Auto, AzureDevops and GithubActions. Environment variable TF_BUILD(https://docs.microsoft.com/en-us/azure/devops/pipelines/build/variables?view=azure-devops&tabs=yaml#system-variables-devops-services) is automically set to true when Azure Devops is detected. Environment variable GITHUB_ACTIONS(https://docs.github.com/en/actions/reference/environment-variables#default-environment-variables) is automatically set to true when Github Actions is detected.", "Auto");
         }
 
         public StringOption Verbosity