Skip to content

Commit

Permalink
Improvements to options doco (microsoft#1685)
Browse files Browse the repository at this point in the history
  • Loading branch information
BernieWhite authored Nov 27, 2023
1 parent fe2a59a commit 9329d28
Show file tree
Hide file tree
Showing 2 changed files with 25 additions and 0 deletions.
1 change: 1 addition & 0 deletions docs/CHANGELOG-v2.md
Original file line number Diff line number Diff line change
Expand Up @@ -180,6 +180,7 @@ What's changed since release v2.7.0:
- Deprecated `SuppressedRuleWarning` option, which will be removed in v3.
- Added support for logging excluded rules by @BernieWhite.
[#1432](https://github.com/microsoft/PSRule/issues/1432)
- Configure `Execution.RuleExcluded` to control output level of excluded rules as `Ignore`, `Warn`, `Error`, or `Debug`.
- Added additional options to schema for PSRule for Azure by @BernieWhite.
[#1446](https://github.com/microsoft/PSRule/issues/1446)
- Improved error message for failing to read options file by @BernieWhite.
Expand Down
24 changes: 24 additions & 0 deletions docs/concepts/PSRule/en-US/about_PSRule_Options.md
Original file line number Diff line number Diff line change
Expand Up @@ -732,6 +732,8 @@ variables:

### Execution.AliasReference

:octicons-milestone-24: v2.9.0

Determines how to handle when an alias to a resource is used.
By defaut, a warning is generated, however this behaviour can be modified by this option.

Expand Down Expand Up @@ -786,6 +788,8 @@ variables:

### Execution.DuplicateResourceId

:octicons-milestone-24: v2.4.0

Determines how to handle duplicate resources identifiers during execution.
A duplicate resource identifier may exist if two resources are defined with the same name, ref, or alias.
By defaut, an error is thrown, however this behaviour can be modified by this option.
Expand Down Expand Up @@ -844,6 +848,8 @@ variables:

### Execution.HashAlgorithm

:octicons-milestone-24: v3.0.0

Specifies the hashing algorithm used by the PSRule runtime.
This hash algorithm is used when generating a resource identifier for an object that does not have a bound name.

Expand Down Expand Up @@ -931,6 +937,8 @@ variables:

### Execution.InvariantCulture

:octicons-milestone-24: v2.9.0

Determines how to report when an invariant culture is used.
By defaut, a warning is generated, however this behaviour can be modified by this option.

Expand Down Expand Up @@ -985,6 +993,8 @@ variables:

### Execution.InitialSessionState

:octicons-milestone-24: v2.5.0

Determines how the initial session state for executing PowerShell code is created.

The following preferences are available:
Expand Down Expand Up @@ -1034,6 +1044,8 @@ variables:

### Execution.RuleInconclusive

:octicons-milestone-24: v2.9.0

Determines how to handle rules that generate inconclusive results.
By defaut, a warning is generated, however this behaviour can be modified by this option.

Expand Down Expand Up @@ -1088,6 +1100,8 @@ variables:

### Execution.SuppressionGroupExpired

:octicons-milestone-24: v2.6.0

Determines how to handle expired suppression groups.
Regardless of the value, an expired suppression group will be ignored.
By defaut, a warning is generated, however this behaviour can be modified by this option.
Expand Down Expand Up @@ -1143,6 +1157,8 @@ variables:

### Execution.RuleExcluded

:octicons-milestone-24: v2.8.0

Determines how to handle excluded rules.
Regardless of the value, excluded rules are ignored.
By defaut, a rule is excluded silently, however this behaviour can be modified by this option.
Expand Down Expand Up @@ -1198,6 +1214,8 @@ variables:

### Execution.RuleSuppressed

:octicons-milestone-24: v2.8.0

Determines how to handle suppressed rules.
Regardless of the value, a suppressed rule is ignored.
By defaut, a warning is generated, however this behaviour can be modified by this option.
Expand Down Expand Up @@ -1253,6 +1271,8 @@ variables:

### Execution.UnprocessedObject

:octicons-milestone-24: v2.9.0

Determines how to report objects that are not processed by any rule.
By defaut, a warning is generated, however this behaviour can be modified by this option.

Expand Down Expand Up @@ -1669,6 +1689,8 @@ variables:

### Input.IgnoreUnchangedPath

:octicons-milestone-24: v2.5.0

By default, PSRule will process all files within an input path.
For large repositories, this can result in a large number of files being processed.
Additionally, for a pull request you may only be interested in files that have changed.
Expand Down Expand Up @@ -2677,6 +2699,8 @@ variables:

### Output.JobSummaryPath

:octicons-milestone-24: v2.6.0

Configures the file path a job summary will be written to when using `Assert-PSRule`.
A job summary is a markdown file that summarizes the results of a job.
When not specified, a job summary will not be generated.
Expand Down

0 comments on commit 9329d28

Please sign in to comment.