Deployed d5cdcfd to v3 with MkDocs 1.6.1 and mike 2.1.3

v3/CHANGELOG-v3/index.html

@@ -2849,6 +2849,16 @@ <h1 id="change-log">Change log<a class="headerlink" href="#change-log" title="Pe
 </ul>
 <h2 id="unreleased">Unreleased<a class="headerlink" href="#unreleased" title="Permanent link">#</a></h2>
 <ul>
+<li>New features:<ul>
+<li>Added support for overriding rule severity level by <a href="https://github.com/BernieWhite">@BernieWhite</a>.
+  <a href="https://github.com/microsoft/PSRule/issues/1180">#1180</a><ul>
+<li>Baselines now accept a new <code>spec.overrides.level</code> property which configures severity level overrides.</li>
+<li>Options now accept a new <code>overrides.level</code> properties which configures severity level overrides.</li>
+<li>For example, a rule that generates an <code>Error</code> can be overridden to <code>Warning</code>.</li>
+</ul>
+</li>
+</ul>
+</li>
 <li>General improvements:<ul>
 <li>Automatically restore missing modules when running CLI by <a href="https://github.com/BernieWhite">@BernieWhite</a>.
   <a href="https://github.com/microsoft/PSRule/issues/2552">#2552</a><ul>
@@ -3206,7 +3216,7 @@ <h2 id="v300-b0084-pre-release">v3.0.0-B0084 (pre-release)<a class="headerlink"
     <span class="md-icon" title="Last update">
       <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M21 13.1c-.1 0-.3.1-.4.2l-1 1 2.1 2.1 1-1c.2-.2.2-.6 0-.8l-1.3-1.3c-.1-.1-.2-.2-.4-.2m-1.9 1.8-6.1 6V23h2.1l6.1-6.1zM12.5 7v5.2l4 2.4-1 1L11 13V7zM11 21.9c-5.1-.5-9-4.8-9-9.9C2 6.5 6.5 2 12 2c5.3 0 9.6 4.1 10 9.3-.3-.1-.6-.2-1-.2s-.7.1-1 .2C19.6 7.2 16.2 4 12 4c-4.4 0-8 3.6-8 8 0 4.1 3.1 7.5 7.1 7.9l-.1.2z"/></svg>
     </span>
-    <span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-date">November 12, 2024</span>
+    <span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-date">November 21, 2024</span>
   </span>
 
 

v3/concepts/PSRule/en-US/about_PSRule_Baseline/index.html

@@ -2770,6 +2770,7 @@ <h2 id="description">Description<a class="headerlink" href="#description" title=
 <p>The following baseline options can be configured:</p>
 <ul>
 <li><a href="../about_PSRule_Options/#configuration">Configuration</a></li>
+<li><a href="../about_PSRule_Options/#overridelevel">Override.Level</a></li>
 <li><a href="../about_PSRule_Options/#ruleinclude">Rule.Include</a></li>
 <li><a href="../about_PSRule_Options/#ruleincludelocal">Rule.IncludeLocal</a></li>
 <li><a href="../about_PSRule_Options/#ruleexclude">Rule.Exclude</a></li>
@@ -2803,8 +2804,9 @@ <h3 id="baseline-specs">Baseline specs<a class="headerlink" href="#baseline-spec
 <span class="w">  </span><span class="nt">annotations</span><span class="p">:</span><span class="w"> </span><span class="p p-Indicator">{</span><span class="w"> </span><span class="p p-Indicator">}</span>
 <span class="nt">spec</span><span class="p">:</span>
 <span class="w">  </span><span class="c1"># One or more baseline options</span>
-<span class="w">  </span><span class="nt">rule</span><span class="p">:</span><span class="w"> </span><span class="p p-Indicator">{</span><span class="w"> </span><span class="p p-Indicator">}</span>
 <span class="w">  </span><span class="nt">configuration</span><span class="p">:</span><span class="w"> </span><span class="p p-Indicator">{</span><span class="w"> </span><span class="p p-Indicator">}</span>
+<span class="w">  </span><span class="nt">override</span><span class="p">:</span><span class="w"> </span><span class="p p-Indicator">{}</span>
+<span class="w">  </span><span class="nt">rule</span><span class="p">:</span><span class="w"> </span><span class="p p-Indicator">{</span><span class="w"> </span><span class="p p-Indicator">}</span>
 </code></pre></div>
 <p>For example:</p>
 <div class="highlight"><pre><span></span><code><span class="nn">---</span>
@@ -2849,8 +2851,9 @@ <h3 id="baseline-specs">Baseline specs<a class="headerlink" href="#baseline-spec
 <span class="w">      </span><span class="nt">&quot;annotations&quot;</span><span class="p">:</span><span class="w"> </span><span class="p">{}</span>
 <span class="w">    </span><span class="p">},</span>
 <span class="w">    </span><span class="nt">&quot;spec&quot;</span><span class="p">:</span><span class="w"> </span><span class="p">{</span>
+<span class="w">      </span><span class="nt">&quot;configuration&quot;</span><span class="p">:</span><span class="w"> </span><span class="p">{},</span>
+<span class="w">      </span><span class="nt">&quot;override&quot;</span><span class="p">:</span><span class="w"> </span><span class="p">{},</span>
 <span class="w">      </span><span class="nt">&quot;rule&quot;</span><span class="p">:</span><span class="w"> </span><span class="p">{},</span>
-<span class="w">      </span><span class="nt">&quot;configuration&quot;</span><span class="p">:</span><span class="w"> </span><span class="p">{}</span>
 <span class="w">    </span><span class="p">}</span>
 <span class="w">  </span><span class="p">}</span>
 <span class="p">]</span>
@@ -3040,7 +3043,7 @@ <h3 id="example-baselinerulejson">Example Baseline.Rule.json<a class="headerlink
     <span class="md-icon" title="Last update">
       <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M21 13.1c-.1 0-.3.1-.4.2l-1 1 2.1 2.1 1-1c.2-.2.2-.6 0-.8l-1.3-1.3c-.1-.1-.2-.2-.4-.2m-1.9 1.8-6.1 6V23h2.1l6.1-6.1zM12.5 7v5.2l4 2.4-1 1L11 13V7zM11 21.9c-5.1-.5-9-4.8-9-9.9C2 6.5 6.5 2 12 2c5.3 0 9.6 4.1 10 9.3-.3-.1-.6-.2-1-.2s-.7.1-1 .2C19.6 7.2 16.2 4 12 4c-4.4 0-8 3.6-8 8 0 4.1 3.1 7.5 7.1 7.9l-.1.2z"/></svg>
     </span>
-    <span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-date">September 1, 2024</span>
+    <span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-date">November 21, 2024</span>
   </span>
 
 

v3/concepts/PSRule/en-US/about_PSRule_Options/index.html

@@ -2821,6 +2821,15 @@
     </span>
   </a>
 
+</li>
+
+          <li class="md-nav__item">
+  <a href="#overridelevel" class="md-nav__link">
+    <span class="md-ellipsis">
+      Override.Level
+    </span>
+  </a>
+
 </li>
 
           <li class="md-nav__item">
@@ -3626,6 +3635,15 @@
     </span>
   </a>
 
+</li>
+
+          <li class="md-nav__item">
+  <a href="#overridelevel" class="md-nav__link">
+    <span class="md-ellipsis">
+      Override.Level
+    </span>
+  </a>
+
 </li>
 
           <li class="md-nav__item">
@@ -3850,6 +3868,7 @@ <h2 id="description">Description<a class="headerlink" href="#description" title=
 <p>Additionally the following baseline options can be included:</p>
 <ul>
 <li><a href="#configuration">Configuration</a></li>
+<li><a href="#overridelevel">Override.Level</a></li>
 <li><a href="#rulebaseline">Rule.Baseline</a></li>
 <li><a href="#ruleinclude">Rule.Include</a></li>
 <li><a href="#ruleincludelocal">Rule.IncludeLocal</a></li>
@@ -5889,6 +5908,37 @@ <h3 id="outputjsonindent">Output.JsonIndent<a class="headerlink" href="#outputjs
 <span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">PSRULE_OUTPUT_JSONINDENT</span>
 <span class="w">  </span><span class="nt">value</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">2</span>
 </code></pre></div>
+<h3 id="overridelevel">Override.Level<a class="headerlink" href="#overridelevel" title="Permanent link">#</a></h3>
+<p>This option is used to override the severity level of one or more rules.
+When specified, the severity level of the rule will be set to the value specified.
+Use this option to change the severity level of a rule to be different then originally defined by the author.</p>
+<p>The following severity levels are available:</p>
+<ul>
+<li><code>Error</code> - A serious problem that must be addressed before going forward.</li>
+<li><code>Warning</code> - A problem that should be addressed.</li>
+<li><code>Information</code> - A minor problem or an opportunity to improve the code.</li>
+</ul>
+<p>This option can be specified using:</p>
+<div class="highlight"><pre><span></span><code><span class="c"># PowerShell: Using the OverrideLevel parameter</span>
+<span class="nv">$option</span> <span class="p">=</span> <span class="nb">New-PSRuleOption</span> <span class="n">-OverrideLevel</span> <span class="p">@{</span> <span class="s1">&#39;rule1&#39;</span> <span class="p">=</span> <span class="s1">&#39;Information&#39;</span> <span class="p">};</span>
+</code></pre></div>
+<div class="highlight"><pre><span></span><code><span class="c"># PowerShell: Using the OVerride.Level hashtable key</span>
+<span class="nv">$option</span> <span class="p">=</span> <span class="nb">New-PSRuleOption</span> <span class="n">-Option</span> <span class="p">@{</span> <span class="s1">&#39;Override.Level.rule1&#39;</span> <span class="p">=</span> <span class="s1">&#39;Information&#39;</span> <span class="p">};</span>
+</code></pre></div>
+<div class="highlight"><pre><span></span><code><span class="c"># PowerShell: Using the OverrideLevel parameter to set YAML</span>
+<span class="nb">Set-PSRuleOption</span> <span class="n">-OverrideLevel</span> <span class="p">@{</span> <span class="s1">&#39;rule1&#39;</span> <span class="p">=</span> <span class="s1">&#39;Information&#39;</span> <span class="p">};</span>
+</code></pre></div>
+<div class="highlight"><pre><span></span><code><span class="c1"># YAML: Using the override/level property</span>
+<span class="nt">override</span><span class="p">:</span>
+<span class="w">  </span><span class="nt">level</span><span class="p">:</span>
+<span class="w">    </span><span class="nt">rule1</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">Information</span>
+</code></pre></div>
+<div class="highlight"><pre><span></span><code><span class="c1"># Bash: Using environment variable</span>
+<span class="nb">export</span><span class="w"> </span><span class="nv">PSRULE_OVERRIDE_LEVEL_RULE1</span><span class="o">=</span><span class="s1">&#39;Information&#39;</span>
+</code></pre></div>
+<div class="highlight"><pre><span></span><code><span class="c"># PowerShell: Using environment variable</span>
+<span class="nv">$env:PSRULE_OVERRIDE_LEVEL_RULE1</span> <span class="p">=</span> <span class="s1">&#39;Information&#39;</span><span class="p">;</span>
+</code></pre></div>
 <h3 id="repositorybaseref">Repository.BaseRef<a class="headerlink" href="#repositorybaseref" title="Permanent link">#</a></h3>
 <p>This option is used for specify the base branch for pull requests.
 When evaluating changes files only PSRule uses this option for comparison with the current branch.
@@ -6215,6 +6265,12 @@ <h3 id="example-ps-ruleyaml">Example ps-rule.yaml<a class="headerlink" href="#ex
 <span class="w">  </span><span class="nt">sarifProblemsOnly</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">false</span>
 <span class="w">  </span><span class="nt">style</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">GitHubActions</span>
 
+<span class="c1"># Overrides the severity level for rules</span>
+<span class="nt">override</span><span class="p">:</span>
+<span class="w">  </span><span class="nt">level</span><span class="p">:</span>
+<span class="w">    </span><span class="nt">Rule1</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">Error</span>
+<span class="w">    </span><span class="nt">Rule2</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">Warning</span>
+
 <span class="c1"># Configure rule suppression</span>
 <span class="nt">suppression</span><span class="p">:</span>
 <span class="w">  </span><span class="nt">storageAccounts.UseHttps</span><span class="p">:</span>
@@ -6319,6 +6375,9 @@ <h3 id="default-ps-ruleyaml">Default ps-rule.yaml<a class="headerlink" href="#de
 <span class="w">  </span><span class="nt">sarifProblemsOnly</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">true</span>
 <span class="w">  </span><span class="nt">style</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">Detect</span>
 
+<span class="nt">override</span><span class="p">:</span>
+<span class="w">  </span><span class="nt">level</span><span class="p">:</span><span class="w"> </span><span class="p p-Indicator">{</span><span class="w"> </span><span class="p p-Indicator">}</span>
+
 <span class="c1"># Configure rule suppression</span>
 <span class="nt">suppression</span><span class="p">:</span><span class="w"> </span><span class="p p-Indicator">{</span><span class="w"> </span><span class="p p-Indicator">}</span>
 
@@ -6371,7 +6430,7 @@ <h2 id="links">Links<a class="headerlink" href="#links" title="Permanent link">#
     <span class="md-icon" title="Last update">
       <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M21 13.1c-.1 0-.3.1-.4.2l-1 1 2.1 2.1 1-1c.2-.2.2-.6 0-.8l-1.3-1.3c-.1-.1-.2-.2-.4-.2m-1.9 1.8-6.1 6V23h2.1l6.1-6.1zM12.5 7v5.2l4 2.4-1 1L11 13V7zM11 21.9c-5.1-.5-9-4.8-9-9.9C2 6.5 6.5 2 12 2c5.3 0 9.6 4.1 10 9.3-.3-.1-.6-.2-1-.2s-.7.1-1 .2C19.6 7.2 16.2 4 12 4c-4.4 0-8 3.6-8 8 0 4.1 3.1 7.5 7.1 7.9l-.1.2z"/></svg>
     </span>
-    <span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-date">September 1, 2024</span>
+    <span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-date">November 21, 2024</span>
   </span>