Skip to content

Commit

Permalink
Update mike requirement from ~=2.0 to ~=2.1 (#758)
Browse files Browse the repository at this point in the history
Updates the requirements on [mike](https://github.com/jimporter/mike) to
permit the latest version.
<details>
<summary>Release notes</summary>
<p><em>Sourced from <a
href="https://github.com/jimporter/mike/releases">mike's
releases</a>.</em></p>
<blockquote>
<h2>v2.1.1</h2>
<h3>Bug fixes</h3>
<ul>
<li>Support using environment variables for <code>INHERIT</code> when
injecting the <code>mike</code> plugin into <code>mkdocs.yml</code></li>
</ul>
</blockquote>
</details>
<details>
<summary>Changelog</summary>
<p><em>Sourced from <a
href="https://github.com/jimporter/mike/blob/master/CHANGES.md">mike's
changelog</a>.</em></p>
<blockquote>
<h2>v2.1.1 (2024-05-03)</h2>
<h3>Bug fixes</h3>
<ul>
<li>Support using environment variables for <code>INHERIT</code> when
injecting the <code>mike</code>
plugin into <code>mkdocs.yml</code></li>
</ul>
<hr />
<h2>v2.1.0 (2024-05-01)</h2>
<h3>New features</h3>
<ul>
<li>When calling <code>set-default</code>, you can now pass
<code>--allow-undefined</code> to set the
default to a version that doesn't exist yet</li>
<li>Add global-level <code>-q</code> / <code>--quiet</code> option to
suppress warning messages</li>
<li>Add support for handling <code>!relative</code> in
<code>mkdocs.yml</code></li>
</ul>
<h3>Bug fixes</h3>
<ul>
<li>When loading an MkDocs config, mike now runs the
<code>startup</code> and <code>shutdown</code>
events</li>
</ul>
<hr />
<h2>v2.0.0 (2023-11-02)</h2>
<h3>New features</h3>
<ul>
<li>Add support for applying arbitrary properties to documentation
versions</li>
<li>Add support for hiding specific versions from the selector when
using the
default themes</li>
<li>Deploy aliases using symbolic links by default; this can be
configured via
<code>--alias-type</code> on the command line or <code>alias_type</code>
in the <code>mike</code> MkDocs plugin</li>
<li>Avoid creating empty commits by default; if you want empty commits,
pass
<code>--allow-empty</code></li>
<li>Look for both <code>mkdocs.yml</code> and <code>mkdocs.yaml</code>
configuration files</li>
<li>Support <code>GIT_COMMITTER_(NAME|EMAIL|DATE)</code> when generating
commits</li>
<li>Allow specifying <code>alias_type</code>,
<code>redirect_template</code>, and <code>deploy_prefix</code> in the
<code>mike</code> MkDocs plugin</li>
<li>Add a <code>--debug</code> flag to help diagnose bugs with mike</li>
<li>Port number is now optional for <code>--dev-addr</code> in
<code>mike serve</code>, defaulting to
8000</li>
</ul>
<h3>Breaking changes</h3>
<ul>
<li><code>--prefix</code> is now <code>--deploy-prefix</code></li>
<li><code>--no-redirect</code> is now
<code>--alias-type=copy</code></li>
<li><code>--ignore</code> is now
<code>--ignore-remote-status</code></li>
<li><code>-f</code> / <code>--force</code> is no longer supported on
subcommands that can push (this
option was too error-prone, and users who really need to force-push can
use
Git directly)</li>
<li><code>--rebase</code> is no longer supported (instead of using this,
it's better to use</li>
</ul>
<!-- raw HTML omitted -->
</blockquote>
<p>... (truncated)</p>
</details>
<details>
<summary>Commits</summary>
<ul>
<li><a
href="https://github.com/jimporter/mike/commit/0bdfe24c20fb0774652230a7abe8466b98098da4"><code>0bdfe24</code></a>
Update version to 2.1.1</li>
<li><a
href="https://github.com/jimporter/mike/commit/3351d5feabff8ee107f4ad6d1f86055843c7dbf1"><code>3351d5f</code></a>
Expand environment variables when injecting the mike plugin; resolves <a
href="https://redirect.github.com/jimporter/mike/issues/217">#217</a></li>
<li><a
href="https://github.com/jimporter/mike/commit/e4d83eda046b1dea0493f91fcacbf86634c93db5"><code>e4d83ed</code></a>
Update version to 2.2.0.dev0</li>
<li><a
href="https://github.com/jimporter/mike/commit/6e6cfbb9a3e78d2ab2a529b72b84e8918c101f6c"><code>6e6cfbb</code></a>
Update version to 2.1.0</li>
<li><a
href="https://github.com/jimporter/mike/commit/5773be928d1a6e99e61755df0d73a8b2ce16660f"><code>5773be9</code></a>
Fix CI</li>
<li><a
href="https://github.com/jimporter/mike/commit/7904925595827ccba3908775b2f9b5add3ae9030"><code>7904925</code></a>
Further tests for deserializing Python objects during
<code>inject_plugin</code></li>
<li><a
href="https://github.com/jimporter/mike/commit/01219bddfeea16f8d6dd6d65d0d84581cf183a3f"><code>01219bd</code></a>
Allow arbitrary Python object in YAML config</li>
<li><a
href="https://github.com/jimporter/mike/commit/ac7b2403cacb0a16892ce915478bac70bd7faf39"><code>ac7b240</code></a>
Handle <code>!relative</code> (and any future constructors) in
mkdocs.yml; resolves <a
href="https://redirect.github.com/jimporter/mike/issues/199">#199</a></li>
<li><a
href="https://github.com/jimporter/mike/commit/fdcc9126b5ded0a273f7d3be3dd1d698f53157ec"><code>fdcc912</code></a>
Add <code>--quiet</code> option; resolves <a
href="https://redirect.github.com/jimporter/mike/issues/210">#210</a></li>
<li><a
href="https://github.com/jimporter/mike/commit/a39ea731c810627341980f4e28b0b5afa55c1c08"><code>a39ea73</code></a>
Add <code>set-default --allow-undefined</code>; see <a
href="https://redirect.github.com/jimporter/mike/issues/210">#210</a></li>
<li>Additional commits viewable in <a
href="https://github.com/jimporter/mike/compare/v2.0.0...v2.1.1">compare
view</a></li>
</ul>
</details>
<br />


Dependabot will resolve any conflicts with this PR as long as you don't
alter it yourself. You can also trigger a rebase manually by commenting
`@dependabot rebase`.

[//]: # (dependabot-automerge-start)
[//]: # (dependabot-automerge-end)

---

<details>
<summary>Dependabot commands and options</summary>
<br />

You can trigger Dependabot actions by commenting on this PR:
- `@dependabot rebase` will rebase this PR
- `@dependabot recreate` will recreate this PR, overwriting any edits
that have been made to it
- `@dependabot merge` will merge this PR after your CI passes on it
- `@dependabot squash and merge` will squash and merge this PR after
your CI passes on it
- `@dependabot cancel merge` will cancel a previously requested merge
and block automerging
- `@dependabot reopen` will reopen this PR if it is closed
- `@dependabot close` will close this PR and stop Dependabot recreating
it. You can achieve the same result by closing it manually
- `@dependabot show <dependency name> ignore conditions` will show all
of the ignore conditions of the specified dependency
- `@dependabot ignore this major version` will close this PR and stop
Dependabot creating any more for this major version (unless you reopen
the PR or upgrade to it yourself)
- `@dependabot ignore this minor version` will close this PR and stop
Dependabot creating any more for this minor version (unless you reopen
the PR or upgrade to it yourself)
- `@dependabot ignore this dependency` will close this PR and stop
Dependabot creating any more for this dependency (unless you reopen the
PR or upgrade to it yourself)


</details>

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Co-authored-by: Francesca L. Bleken <48128015+francescalb@users.noreply.github.com>
  • Loading branch information
dependabot[bot] and francescalb committed May 8, 2024
1 parent f8549aa commit 01e8617
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion requirements_docs.txt
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
mike~=2.0
mike~=2.1
mkdocs~=1.5
mkdocs-awesome-pages-plugin~=2.9
mkdocs-material~=9.5; python_version>="3.8"
Expand Down

0 comments on commit 01e8617

Please sign in to comment.