Deployed 2c81463 to v3 with MkDocs 1.5.3 and mike 2.0.0

BernieWhite · Apr 20, 2024 · 950cb71 · 950cb71
1 parent 7184caa
commit 950cb71
Show file tree

Hide file tree

Showing 12 changed files with 176 additions and 13 deletions.
diff --git a/v3/CHANGELOG-v3/index.html b/v3/CHANGELOG-v3/index.html
@@ -2767,6 +2767,8 @@ <h2 id="v300-b0179-pre-release">v3.0.0-B0179 (pre-release)<a class="headerlink"
 <li>Bug fixes:<ul>
 <li>Fixed discovery of installed modules in CLI by <a href="https://github.com/BernieWhite">@BernieWhite</a>.
   <a href="https://github.com/microsoft/PSRule/issues/1779">#1779</a></li>
+<li>Fixed for git head in tests by <a href="https://github.com/BernieWhite">@BernieWhite</a>.
+  <a href="https://github.com/microsoft/PSRule/issues/1801">#1801</a></li>
 </ul>
 </li>
 </ul>
@@ -2981,7 +2983,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.1-2.1-2M12.5 7v5.2l4 2.4-1 1L11 13V7h1.5M11 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.2v1.8Z"/></svg>
     </span>
-    <span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-date">April 16, 2024</span>
+    <span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-date">April 20, 2024</span>
   </span>
 
 

diff --git a/v3/__pycache__/hooks.cpython-311.pyc b/v3/__pycache__/hooks.cpython-311.pyc
diff --git a/v3/concepts/cli/module/index.html b/v3/concepts/cli/module/index.html
@@ -2829,6 +2829,29 @@ <h2 id="next-steps">Next steps<a class="headerlink" href="#next-steps" title="Pe
 
 
 
+
+  <span class="md-source-file__fact">
+
+
+  <span class="md-icon" title="Contributors">
+    <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 2A10 10 0 0 0 2 12c0 4.42 2.87 8.17 6.84 9.5.5.08.66-.23.66-.5v-1.69c-2.77.6-3.36-1.34-3.36-1.34-.46-1.16-1.11-1.47-1.11-1.47-.91-.62.07-.6.07-.6 1 .07 1.53 1.03 1.53 1.03.87 1.52 2.34 1.07 2.91.83.09-.65.35-1.09.63-1.34-2.22-.25-4.55-1.11-4.55-4.92 0-1.11.38-2 1.03-2.71-.1-.25-.45-1.29.1-2.64 0 0 .84-.27 2.75 1.02.79-.22 1.65-.33 2.5-.33.85 0 1.71.11 2.5.33 1.91-1.29 2.75-1.02 2.75-1.02.55 1.35.2 2.39.1 2.64.65.71 1.03 1.6 1.03 2.71 0 3.82-2.34 4.66-4.57 4.91.36.31.69.92.69 1.85V21c0 .27.16.59.67.5C19.14 20.16 22 16.42 22 12A10 10 0 0 0 12 2Z"/></svg>
+  </span>
+  <span>GitHub</span>
+
+
+    <nav>
+
+        <a href="https://github.com/BernieWhite" class="md-author" title="@BernieWhite">
+
+          <img src="https://avatars.githubusercontent.com/u/13513058?v=4&size=72" alt="BernieWhite">
+        </a>
+
+
+
+    </nav>
+  </span>
+
+
   </aside>
 
 

diff --git a/v3/concepts/cli/run/index.html b/v3/concepts/cli/run/index.html
@@ -2819,6 +2819,29 @@ <h2 id="next-steps">Next steps<a class="headerlink" href="#next-steps" title="Pe
 
 
 
+
+  <span class="md-source-file__fact">
+
+
+  <span class="md-icon" title="Contributors">
+    <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 2A10 10 0 0 0 2 12c0 4.42 2.87 8.17 6.84 9.5.5.08.66-.23.66-.5v-1.69c-2.77.6-3.36-1.34-3.36-1.34-.46-1.16-1.11-1.47-1.11-1.47-.91-.62.07-.6.07-.6 1 .07 1.53 1.03 1.53 1.03.87 1.52 2.34 1.07 2.91.83.09-.65.35-1.09.63-1.34-2.22-.25-4.55-1.11-4.55-4.92 0-1.11.38-2 1.03-2.71-.1-.25-.45-1.29.1-2.64 0 0 .84-.27 2.75 1.02.79-.22 1.65-.33 2.5-.33.85 0 1.71.11 2.5.33 1.91-1.29 2.75-1.02 2.75-1.02.55 1.35.2 2.39.1 2.64.65.71 1.03 1.6 1.03 2.71 0 3.82-2.34 4.66-4.57 4.91.36.31.69.92.69 1.85V21c0 .27.16.59.67.5C19.14 20.16 22 16.42 22 12A10 10 0 0 0 12 2Z"/></svg>
+  </span>
+  <span>GitHub</span>
+
+
+    <nav>
+
+        <a href="https://github.com/BernieWhite" class="md-author" title="@BernieWhite">
+
+          <img src="https://avatars.githubusercontent.com/u/13513058?v=4&size=72" alt="BernieWhite">
+        </a>
+
+
+
+    </nav>
+  </span>
+
+
   </aside>
 
 

diff --git a/v3/deprecations/index.html b/v3/deprecations/index.html
@@ -1678,6 +1678,15 @@
     </span>
   </a>
 
+</li>
+
+          <li class="md-nav__item">
+  <a href="#git-head-input-object" class="md-nav__link">
+    <span class="md-ellipsis">
+      Git Head input object
+    </span>
+  </a>
+
 </li>
 
           <li class="md-nav__item">
@@ -2628,6 +2637,15 @@
     </span>
   </a>
 
+</li>
+
+          <li class="md-nav__item">
+  <a href="#git-head-input-object" class="md-nav__link">
+    <span class="md-ellipsis">
+      Git Head input object
+    </span>
+  </a>
+
 </li>
 
           <li class="md-nav__item">
@@ -2755,6 +2773,13 @@ <h3 id="execution-options">Execution options<a class="headerlink" href="#executi
 <p>You do not need to configure both options.
 If you have the deprecated option configured, switch to the new option.</p>
 </div>
+<h3 id="git-head-input-object">Git Head input object<a class="headerlink" href="#git-head-input-object" title="Permanent link">#</a></h3>
+<p>Previously when the <code>Input.Format</code> option was set to <code>File</code> the <code>.git/HEAD</code> file was emitted as an input object.
+The original purpose of this feature was to allow conventions to run once against the root of the repository.
+Subsequent changes to PSRule have made this feature redundant by adding support for the <code>-Initialize</code> block.</p>
+<p>From <em>v3</em> the <code>.git/HEAD</code> file will no longer be emitted as an input object.</p>
+<p>Consider adding or updating a convention that uses the <code>-Initialize</code> block to emit run initialization logic.
+Yon can also use the <code>-Initialize</code> block to emit a custom object to the pipeline by using the <code>$PSRule.ImportWithType</code> method.</p>
 <h3 id="rule-output-object">Rule output object<a class="headerlink" href="#rule-output-object" title="Permanent link">#</a></h3>
 <p>Several properties of the rule object have been renamed to improve consistency with other objects.
 Previously rules returned by <code>Get-PSRule</code> returned a rule object which included the following properties:</p>
@@ -2827,7 +2852,7 @@ <h3 id="resources-without-an-api-version">Resources without an API version<a cla
     <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.1-2.1-2M12.5 7v5.2l4 2.4-1 1L11 13V7h1.5M11 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.2v1.8Z"/></svg>
     </span>
-    <span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-date">April 23, 2023</span>
+    <span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-date">April 20, 2024</span>
   </span>
 
 

diff --git a/v3/expressions/functions/index.html b/v3/expressions/functions/index.html
@@ -2819,6 +2819,29 @@ <h2 id="recommended-content">Recommended content<a class="headerlink" href="#rec
 
 
 
+
+  <span class="md-source-file__fact">
+
+
+  <span class="md-icon" title="Contributors">
+    <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 2A10 10 0 0 0 2 12c0 4.42 2.87 8.17 6.84 9.5.5.08.66-.23.66-.5v-1.69c-2.77.6-3.36-1.34-3.36-1.34-.46-1.16-1.11-1.47-1.11-1.47-.91-.62.07-.6.07-.6 1 .07 1.53 1.03 1.53 1.03.87 1.52 2.34 1.07 2.91.83.09-.65.35-1.09.63-1.34-2.22-.25-4.55-1.11-4.55-4.92 0-1.11.38-2 1.03-2.71-.1-.25-.45-1.29.1-2.64 0 0 .84-.27 2.75 1.02.79-.22 1.65-.33 2.5-.33.85 0 1.71.11 2.5.33 1.91-1.29 2.75-1.02 2.75-1.02.55 1.35.2 2.39.1 2.64.65.71 1.03 1.6 1.03 2.71 0 3.82-2.34 4.66-4.57 4.91.36.31.69.92.69 1.85V21c0 .27.16.59.67.5C19.14 20.16 22 16.42 22 12A10 10 0 0 0 12 2Z"/></svg>
+  </span>
+  <span>GitHub</span>
+
+
+    <nav>
+
+        <a href="https://github.com/BernieWhite" class="md-author" title="@BernieWhite">
+
+          <img src="https://avatars.githubusercontent.com/u/13513058?v=4&size=72" alt="BernieWhite">
+        </a>
+
+
+
+    </nav>
+  </span>
+
+
   </aside>
 
 

diff --git a/v3/expressions/sub-selectors/index.html b/v3/expressions/sub-selectors/index.html
@@ -3057,6 +3057,29 @@ <h2 id="recommended-content">Recommended content<a class="headerlink" href="#rec
 
 
 
+
+  <span class="md-source-file__fact">
+
+
+  <span class="md-icon" title="Contributors">
+    <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 2A10 10 0 0 0 2 12c0 4.42 2.87 8.17 6.84 9.5.5.08.66-.23.66-.5v-1.69c-2.77.6-3.36-1.34-3.36-1.34-.46-1.16-1.11-1.47-1.11-1.47-.91-.62.07-.6.07-.6 1 .07 1.53 1.03 1.53 1.03.87 1.52 2.34 1.07 2.91.83.09-.65.35-1.09.63-1.34-2.22-.25-4.55-1.11-4.55-4.92 0-1.11.38-2 1.03-2.71-.1-.25-.45-1.29.1-2.64 0 0 .84-.27 2.75 1.02.79-.22 1.65-.33 2.5-.33.85 0 1.71.11 2.5.33 1.91-1.29 2.75-1.02 2.75-1.02.55 1.35.2 2.39.1 2.64.65.71 1.03 1.6 1.03 2.71 0 3.82-2.34 4.66-4.57 4.91.36.31.69.92.69 1.85V21c0 .27.16.59.67.5C19.14 20.16 22 16.42 22 12A10 10 0 0 0 12 2Z"/></svg>
+  </span>
+  <span>GitHub</span>
+
+
+    <nav>
+
+        <a href="https://github.com/BernieWhite" class="md-author" title="@BernieWhite">
+
+          <img src="https://avatars.githubusercontent.com/u/13513058?v=4&size=72" alt="BernieWhite">
+        </a>
+
+
+
+    </nav>
+  </span>
+
+
   </aside>
 
 

diff --git a/v3/keywords/PSRule/en-US/about_PSRule_Keywords/index.html b/v3/keywords/PSRule/en-US/about_PSRule_Keywords/index.html
@@ -3154,6 +3154,29 @@ <h2 id="links">Links<a class="headerlink" href="#links" title="Permanent link">#
 
 
 
+
+  <span class="md-source-file__fact">
+
+
+  <span class="md-icon" title="Contributors">
+    <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 2A10 10 0 0 0 2 12c0 4.42 2.87 8.17 6.84 9.5.5.08.66-.23.66-.5v-1.69c-2.77.6-3.36-1.34-3.36-1.34-.46-1.16-1.11-1.47-1.11-1.47-.91-.62.07-.6.07-.6 1 .07 1.53 1.03 1.53 1.03.87 1.52 2.34 1.07 2.91.83.09-.65.35-1.09.63-1.34-2.22-.25-4.55-1.11-4.55-4.92 0-1.11.38-2 1.03-2.71-.1-.25-.45-1.29.1-2.64 0 0 .84-.27 2.75 1.02.79-.22 1.65-.33 2.5-.33.85 0 1.71.11 2.5.33 1.91-1.29 2.75-1.02 2.75-1.02.55 1.35.2 2.39.1 2.64.65.71 1.03 1.6 1.03 2.71 0 3.82-2.34 4.66-4.57 4.91.36.31.69.92.69 1.85V21c0 .27.16.59.67.5C19.14 20.16 22 16.42 22 12A10 10 0 0 0 12 2Z"/></svg>
+  </span>
+  <span>GitHub</span>
+
+
+    <nav>
+
+        <a href="https://github.com/BernieWhite" class="md-author" title="@BernieWhite">
+
+          <img src="https://avatars.githubusercontent.com/u/13513058?v=4&size=72" alt="BernieWhite">
+        </a>
+
+
+
+    </nav>
+  </span>
+
+
   </aside>
 
 

diff --git a/v3/quickstart/standalone-rule/index.html b/v3/quickstart/standalone-rule/index.html
@@ -3188,6 +3188,29 @@ <h3 id="testing-service-objects">Testing service objects<a class="headerlink" hr
 
 
 
+
+  <span class="md-source-file__fact">
+
+
+  <span class="md-icon" title="Contributors">
+    <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 2A10 10 0 0 0 2 12c0 4.42 2.87 8.17 6.84 9.5.5.08.66-.23.66-.5v-1.69c-2.77.6-3.36-1.34-3.36-1.34-.46-1.16-1.11-1.47-1.11-1.47-.91-.62.07-.6.07-.6 1 .07 1.53 1.03 1.53 1.03.87 1.52 2.34 1.07 2.91.83.09-.65.35-1.09.63-1.34-2.22-.25-4.55-1.11-4.55-4.92 0-1.11.38-2 1.03-2.71-.1-.25-.45-1.29.1-2.64 0 0 .84-.27 2.75 1.02.79-.22 1.65-.33 2.5-.33.85 0 1.71.11 2.5.33 1.91-1.29 2.75-1.02 2.75-1.02.55 1.35.2 2.39.1 2.64.65.71 1.03 1.6 1.03 2.71 0 3.82-2.34 4.66-4.57 4.91.36.31.69.92.69 1.85V21c0 .27.16.59.67.5C19.14 20.16 22 16.42 22 12A10 10 0 0 0 12 2Z"/></svg>
+  </span>
+  <span>GitHub</span>
+
+
+    <nav>
+
+        <a href="https://github.com/BernieWhite" class="md-author" title="@BernieWhite">
+
+          <img src="https://avatars.githubusercontent.com/u/13513058?v=4&size=72" alt="BernieWhite">
+        </a>
+
+
+
+    </nav>
+  </span>
+
+
   </aside>
 
 

diff --git a/v3/search/search_index.json b/v3/search/search_index.json
diff --git a/v3/sitemap.xml.gz b/v3/sitemap.xml.gz
diff --git a/v3/upgrade-notes/index.html b/v3/upgrade-notes/index.html
@@ -1660,9 +1660,9 @@
 </li>
 
           <li class="md-nav__item">
-  <a href="#using-powershell-73-or-later" class="md-nav__link">
+  <a href="#using-powershell-74-or-later" class="md-nav__link">
     <span class="md-ellipsis">
-      Using PowerShell 7.3 or later
+      Using PowerShell 7.4 or later
     </span>
   </a>
 
@@ -2706,9 +2706,9 @@
 </li>
 
           <li class="md-nav__item">
-  <a href="#using-powershell-73-or-later" class="md-nav__link">
+  <a href="#using-powershell-74-or-later" class="md-nav__link">
     <span class="md-ellipsis">
-      Using PowerShell 7.3 or later
+      Using PowerShell 7.4 or later
     </span>
   </a>
 
@@ -2885,16 +2885,14 @@ <h3 id="unbound-object-names">Unbound object names<a class="headerlink" href="#u
 <p>Update any existing keys set with the <a href="https://aka.ms/ps-rule/options#suppression">Suppression</a> option to use the new SHA-512 hash.</p>
 </li>
 </ol>
-<h3 id="using-powershell-73-or-later">Using PowerShell 7.3 or later<a class="headerlink" href="#using-powershell-73-or-later" title="Permanent link">#</a></h3>
+<h3 id="using-powershell-74-or-later">Using PowerShell 7.4 or later<a class="headerlink" href="#using-powershell-74-or-later" title="Permanent link">#</a></h3>
 <p>From <em>v3.0.0</em>, PSRule requires:</p>
 <ul>
 <li>Windows PowerShell 5.1 for running as a PowerShell module. <em>OR</em></li>
-<li>PowerShell 7.3 or later for development, building locally, or running as a PowerShell module.</li>
+<li>PowerShell 7.4 or later for development, building locally, or running as a PowerShell module.</li>
 </ul>
 <p>Support for Windows PowerShell 5.1 is deprecated and will be removed in a future release of PSRule (v4).
-We recommend upgrading to PowerShell 7.3 or later.</p>
-<p>At the time of writing, PowerShell 7.3 is the most recent version of PowerShell.
-PowerShell 7.4 is expected, and PSRule v4 will aim to support the latest version of PowerShell as the minimum requirement.</p>
+We recommend upgrading to PowerShell 7.4 or later.</p>
 <h3 id="changes-to-cli-commands">Changes to CLI commands<a class="headerlink" href="#changes-to-cli-commands" title="Permanent link">#</a></h3>
 <p>From <em>v3.0.0</em>, the CLI command names have been renamed to simplify usage.
 The following changes have been made:</p>
@@ -3153,7 +3151,7 @@ <h3 id="replaced-rule-target-properties">Replaced $Rule target properties<a clas
     <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.1-2.1-2M12.5 7v5.2l4 2.4-1 1L11 13V7h1.5M11 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.2v1.8Z"/></svg>
     </span>
-    <span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-date">January 16, 2024</span>
+    <span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-date">April 20, 2024</span>
   </span>