Deployed 1e361d5 to latest with MkDocs 1.5.2 and mike 1.1.2

latest/CHANGELOG/index.html

@@ -620,8 +620,15 @@
     <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
 
         <li class="md-nav__item">
-  <a href="#unreleased-changes-2023-08-30" class="md-nav__link">
-    Unreleased changes (2023-08-30)
+  <a href="#unreleased" class="md-nav__link">
+    Unreleased
+  </a>
+
+</li>
+
+        <li class="md-nav__item">
+  <a href="#v251-2023-08-30" class="md-nav__link">
+    v2.5.1 (2023-08-30)
   </a>
 
 </li>
@@ -1087,8 +1094,15 @@
     <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
 
         <li class="md-nav__item">
-  <a href="#unreleased-changes-2023-08-30" class="md-nav__link">
-    Unreleased changes (2023-08-30)
+  <a href="#unreleased" class="md-nav__link">
+    Unreleased
+  </a>
+
+</li>
+
+        <li class="md-nav__item">
+  <a href="#v251-2023-08-30" class="md-nav__link">
+    v2.5.1 (2023-08-30)
   </a>
 
 </li>
@@ -1270,11 +1284,16 @@
 
 
 <h1 id="changelog">Changelog<a class="headerlink" href="#changelog" title="Permanent link">&para;</a></h1>
-<h2 id="unreleased-changes-2023-08-30"><a href="https://github.com/SINTEF/ci-cd/tree/Unreleased changes">Unreleased changes</a> (2023-08-30)<a class="headerlink" href="#unreleased-changes-2023-08-30" title="Permanent link">&para;</a></h2>
-<p><a href="https://github.com/SINTEF/ci-cd/compare/v2.5.0...Unreleased changes">Full Changelog</a></p>
+<h2 id="unreleased"><a href="https://github.com/SINTEF/ci-cd/tree/HEAD">Unreleased</a><a class="headerlink" href="#unreleased" title="Permanent link">&para;</a></h2>
+<p><a href="https://github.com/SINTEF/ci-cd/compare/v2.5.1...HEAD">Full Changelog</a></p>
 <p><strong>Fixed bugs:</strong></p>
 <ul>
 <li>Regression in <code>--full-docs-dir</code> input <a href="https://github.com/SINTEF/ci-cd/issues/174">#174</a></li>
+</ul>
+<h2 id="v251-2023-08-30"><a href="https://github.com/SINTEF/ci-cd/tree/v2.5.1">v2.5.1</a> (2023-08-30)<a class="headerlink" href="#v251-2023-08-30" title="Permanent link">&para;</a></h2>
+<p><a href="https://github.com/SINTEF/ci-cd/compare/v2.5.0...v2.5.1">Full Changelog</a></p>
+<p><strong>Fixed bugs:</strong></p>
+<ul>
 <li>Too strict release tag name requirements <a href="https://github.com/SINTEF/ci-cd/issues/172">#172</a></li>
 </ul>
 <p><strong>Merged pull requests:</strong></p>

latest/hooks/docs_api_reference/index.html

@@ -1095,7 +1095,7 @@ <h2 id="usage-example">Usage example<a class="headerlink" href="#usage-example"
 It is meant to be complete as is.</p>
 <div class="highlight"><pre><span></span><code><span class="nt">repos</span><span class="p">:</span>
 <span class="w">  </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">repo</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">https://github.com/SINTEF/ci-cd</span>
-<span class="w">    </span><span class="nt">rev</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">v2.5.0</span>
+<span class="w">    </span><span class="nt">rev</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">v2.5.1</span>
 <span class="w">    </span><span class="nt">hooks</span><span class="p">:</span>
 <span class="w">    </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">id</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">docs-api-reference</span>
 <span class="w">      </span><span class="nt">args</span><span class="p">:</span>

latest/hooks/docs_landing_page/index.html

@@ -1026,7 +1026,7 @@ <h2 id="usage-example">Usage example<a class="headerlink" href="#usage-example"
 It is meant to be complete as is.</p>
 <div class="highlight"><pre><span></span><code><span class="nt">repos</span><span class="p">:</span>
 <span class="w">  </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">repo</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">https://github.com/SINTEF/ci-cd</span>
-<span class="w">    </span><span class="nt">rev</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">v2.5.0</span>
+<span class="w">    </span><span class="nt">rev</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">v2.5.1</span>
 <span class="w">    </span><span class="nt">hooks</span><span class="p">:</span>
 <span class="w">    </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">id</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">docs-landing-page</span>
 <span class="w">      </span><span class="nt">args</span><span class="p">:</span>

latest/hooks/update_pyproject/index.html

@@ -1095,7 +1095,7 @@ <h2 id="usage-example">Usage example<a class="headerlink" href="#usage-example"
 It is meant to be complete as is.</p>
 <div class="highlight"><pre><span></span><code><span class="nt">repos</span><span class="p">:</span>
 <span class="w">  </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">repo</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">https://github.com/SINTEF/ci-cd</span>
-<span class="w">    </span><span class="nt">rev</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">v2.5.0</span>
+<span class="w">    </span><span class="nt">rev</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">v2.5.1</span>
 <span class="w">    </span><span class="nt">hooks</span><span class="p">:</span>
 <span class="w">    </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">id</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">update-pyproject</span>
 <span class="w">      </span><span class="nt">args</span><span class="p">:</span>

latest/index.html

@@ -1068,7 +1068,7 @@
 
 
 <h1 id="cicd-tools">CI/CD tools<a class="headerlink" href="#cicd-tools" title="Permanent link">&para;</a></h1>
-<p><strong>Current version to use:</strong> <code>v2.5.0</code></p>
+<p><strong>Current version to use:</strong> <code>v2.5.1</code></p>
 <p>Use tried and tested continuous integration (CI) and continuous deployment (CD) tools from this repository.</p>
 <p>Currently, the repository offers GitHub Actions callable/reusable workflows and <a href="https://pre-commit.com">pre-commit</a> hooks.</p>
 <h2 id="github-actions-callablereusable-workflows">GitHub Actions callable/reusable Workflows<a class="headerlink" href="#github-actions-callablereusable-workflows" title="Permanent link">&para;</a></h2>

latest/workflows/cd_release/index.html

@@ -1028,7 +1028,7 @@ <h1 id="cd-release">CD - Release<a class="headerlink" href="#cd-release" title="
 <h2 id="updating-instances-of-version-in-repository-files">Updating instances of version in repository files<a class="headerlink" href="#updating-instances-of-version-in-repository-files" title="Permanent link">&para;</a></h2>
 <p>The content of repository files can be updated to use the new version where necessary.
 This is done through the <code>version_update_changes</code> (and <code>version_update_changes_separator</code>) inputs.</p>
-<p>To see an example of how to use the <code>version_update_changes</code> (and <code>version_update_changes_separator</code>) see for example the <a href="https://github.com/SINTEF/ci-cd/blob/v2.5.0/.github/workflows/_local_cd_release.yml">workflow used by the SINTEF/ci-cd repository</a> calling the <em>CD Release</em> workflow.</p>
+<p>To see an example of how to use the <code>version_update_changes</code> (and <code>version_update_changes_separator</code>) see for example the <a href="https://github.com/SINTEF/ci-cd/blob/v2.5.1/.github/workflows/_local_cd_release.yml">workflow used by the SINTEF/ci-cd repository</a> calling the <em>CD Release</em> workflow.</p>
 <p>Some notes to consider and respect when using <code>version_update_changes</code> are:</p>
 <ul>
 <li>The value of <code>version_update_changes_separator</code> applies to <em>all</em> lines given in <code>version_update_changes</code>, meaning it should be a character, or series of characters, which will not be part of the actual content.</li>
@@ -1327,7 +1327,7 @@ <h2 id="usage-example">Usage example<a class="headerlink" href="#usage-example"
 <span class="nt">jobs</span><span class="p">:</span>
 <span class="w">  </span><span class="nt">publish</span><span class="p">:</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">Publish package and documentation</span>
-<span class="w">    </span><span class="nt">uses</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">SINTEF/ci-cd/.github/workflows/cd_release.yml@v2.5.0</span>
+<span class="w">    </span><span class="nt">uses</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">SINTEF/ci-cd/.github/workflows/cd_release.yml@v2.5.1</span>
 <span class="w">    </span><span class="nt">if</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">github.repository == &#39;SINTEF/my-python-package&#39; &amp;&amp; startsWith(github.ref, &#39;refs/tags/v&#39;)</span>
 <span class="w">    </span><span class="nt">with</span><span class="p">:</span>
 <span class="w">      </span><span class="nt">git_username</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;Casper</span><span class="nv"> </span><span class="s">Welzel</span><span class="nv"> </span><span class="s">Andersen&quot;</span>

latest/workflows/ci_automerge_prs/index.html

@@ -1081,7 +1081,7 @@ <h2 id="usage-example">Usage example<a class="headerlink" href="#usage-example"
 <span class="nt">jobs</span><span class="p">:</span>
 <span class="w">  </span><span class="nt">update-dependency-branch</span><span class="p">:</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">Call external workflow</span>
-<span class="w">    </span><span class="nt">uses</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">SINTEF/ci-cd/.github/workflows/ci_automerge_prs.yml@v2.5.0</span>
+<span class="w">    </span><span class="nt">uses</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">SINTEF/ci-cd/.github/workflows/ci_automerge_prs.yml@v2.5.1</span>
 <span class="w">    </span><span class="nt">if</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">github.repository_owner == &#39;SINTEF&#39; &amp;&amp; ( ( startsWith(github.event.pull_request.head.ref, &#39;dependabot/&#39;) &amp;&amp; github.actor == &#39;dependabot[bot]&#39; ) || ( github.event.pull_request.head.ref == &#39;ci/update-pyproject&#39; &amp;&amp; github.actor == &#39;CasperWA&#39; ) )</span>
 <span class="w">    </span><span class="nt">secrets</span><span class="p">:</span>
 <span class="w">      </span><span class="nt">PAT</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">${{ secrets.RELEASE_PAT }}</span>
@@ -1098,7 +1098,7 @@ <h2 id="usage-example">Usage example<a class="headerlink" href="#usage-example"
 <span class="nt">jobs</span><span class="p">:</span>
 <span class="w">  </span><span class="nt">update-dependency-branch</span><span class="p">:</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">Call external workflow</span>
-<span class="w">    </span><span class="nt">uses</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">SINTEF/ci-cd/.github/workflows/ci_automerge_prs.yml@v2.5.0</span>
+<span class="w">    </span><span class="nt">uses</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">SINTEF/ci-cd/.github/workflows/ci_automerge_prs.yml@v2.5.1</span>
 <span class="w">    </span><span class="nt">if</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">github.repository_owner == &#39;SINTEF&#39; &amp;&amp; ( ( startsWith(github.event.pull_request.head.ref, &#39;dependabot/&#39;) &amp;&amp; github.actor == &#39;dependabot[bot]&#39; ) || ( github.event.pull_request.head.ref == &#39;ci/update-pyproject&#39; &amp;&amp; github.actor == &#39;CasperWA&#39; ) )</span>
 <span class="w">    </span><span class="nt">with</span><span class="p">:</span>
 <span class="w">      </span><span class="nt">perform_changes</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">true</span>
@@ -1119,7 +1119,7 @@ <h2 id="usage-example">Usage example<a class="headerlink" href="#usage-example"
 <span class="nt">jobs</span><span class="p">:</span>
 <span class="w">  </span><span class="nt">update-dependency-branch</span><span class="p">:</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">Call external workflow</span>
-<span class="w">    </span><span class="nt">uses</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">SINTEF/ci-cd/.github/workflows/ci_automerge_prs.yml@v2.5.0</span>
+<span class="w">    </span><span class="nt">uses</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">SINTEF/ci-cd/.github/workflows/ci_automerge_prs.yml@v2.5.1</span>
 <span class="w">    </span><span class="nt">if</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">github.repository_owner == &#39;SINTEF&#39; &amp;&amp; ( ( startsWith(github.event.pull_request.head.ref, &#39;dependabot/&#39;) &amp;&amp; github.actor == &#39;dependabot[bot]&#39; ) || ( github.event.pull_request.head.ref == &#39;ci/update-pyproject&#39; &amp;&amp; github.actor == &#39;CasperWA&#39; ) )</span>
 <span class="w">    </span><span class="nt">with</span><span class="p">:</span>
 <span class="w">      </span><span class="nt">perform_changes</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">true</span>

latest/workflows/ci_cd_updated_default_branch/index.html

@@ -1297,7 +1297,7 @@ <h2 id="usage-example">Usage example<a class="headerlink" href="#usage-example"
 <span class="nt">jobs</span><span class="p">:</span>
 <span class="w">  </span><span class="nt">updates-to-stable</span><span class="p">:</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">Call external workflow</span>
-<span class="w">    </span><span class="nt">uses</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">SINTEF/ci-cd/.github/workflows/ci_cd_updated_default_branch.yml@v2.5.0</span>
+<span class="w">    </span><span class="nt">uses</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">SINTEF/ci-cd/.github/workflows/ci_cd_updated_default_branch.yml@v2.5.1</span>
 <span class="w">    </span><span class="nt">if</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">github.repository_owner == &#39;SINTEF&#39;</span>
 <span class="w">    </span><span class="nt">with</span><span class="p">:</span>
 <span class="w">      </span><span class="nt">git_username</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;Casper</span><span class="nv"> </span><span class="s">Welzel</span><span class="nv"> </span><span class="s">Andersen&quot;</span>

latest/workflows/ci_check_pyproject_dependencies/index.html

@@ -1049,7 +1049,7 @@ <h2 id="ignoring-dependencies">Ignoring dependencies<a class="headerlink" href="
 <div class="highlight"><pre><span></span><code><span class="c1"># ...</span>
 <span class="nt">jobs</span><span class="p">:</span>
 <span class="w">  </span><span class="nt">check-dependencies</span><span class="p">:</span>
-<span class="w">    </span><span class="nt">uses</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">SINTEF/ci-cd/.github/workflows/ci_check_pyproject_dependencies.yml@v2.5.0</span>
+<span class="w">    </span><span class="nt">uses</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">SINTEF/ci-cd/.github/workflows/ci_check_pyproject_dependencies.yml@v2.5.1</span>
 <span class="w">    </span><span class="nt">with</span><span class="p">:</span>
 <span class="w">      </span><span class="c1"># ...</span>
 <span class="w">      </span><span class="c1"># For Sphinx, ignore all updates for/from version 4.5.0 and up / keep the minimum version for Sphinx at 4.5.0.</span>
@@ -1173,7 +1173,7 @@ <h2 id="usage-example">Usage example<a class="headerlink" href="#usage-example"
 <span class="nt">jobs</span><span class="p">:</span>
 <span class="w">  </span><span class="nt">check-dependencies</span><span class="p">:</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">Call external workflow</span>
-<span class="w">    </span><span class="nt">uses</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">SINTEF/ci-cd/.github/workflows/ci_check_pyproject_dependencies.yml@v2.5.0</span>
+<span class="w">    </span><span class="nt">uses</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">SINTEF/ci-cd/.github/workflows/ci_check_pyproject_dependencies.yml@v2.5.1</span>
 <span class="w">    </span><span class="nt">if</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">github.repository_owner == &#39;SINTEF&#39;</span>
 <span class="w">    </span><span class="nt">with</span><span class="p">:</span>
 <span class="w">      </span><span class="nt">git_username</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;Casper</span><span class="nv"> </span><span class="s">Welzel</span><span class="nv"> </span><span class="s">Andersen&quot;</span>