jimporter/mike (mike)
### [`v2.1.3`](https://togithub.com/jimporter/mike/blob/HEAD/CHANGES.md#v213-2024-08-12)
[Compare Source](https://togithub.com/jimporter/mike/compare/v2.1.2...v2.1.3)
##### Bug fixes
- When deploying using a deploy prefix, only delete stale versions of the docs
within that prefix
***
### [`v2.1.2`](https://togithub.com/jimporter/mike/blob/HEAD/CHANGES.md#v212-2024-06-23)
[Compare Source](https://togithub.com/jimporter/mike/compare/v2.1.1...v2.1.2)
##### Bug fixes
- Remove ambiguity of some Git commands so that file and branch names don't
collide
***
### [`v2.1.1`](https://togithub.com/jimporter/mike/blob/HEAD/CHANGES.md#v211-2024-05-03)
[Compare Source](https://togithub.com/jimporter/mike/compare/v2.1.0...v2.1.1)
##### Bug fixes
- Support using environment variables for `INHERIT` when injecting the `mike`
plugin into `mkdocs.yml`
***
### [`v2.1.0`](https://togithub.com/jimporter/mike/blob/HEAD/CHANGES.md#v210-2024-05-01)
[Compare Source](https://togithub.com/jimporter/mike/compare/v2.0.0...v2.1.0)
##### New features
- When calling `set-default`, you can now pass `--allow-undefined` to set the
default to a version that doesn't exist yet
- Add global-level `-q` / `--quiet` option to suppress warning messages
- Add support for handling `!relative` in `mkdocs.yml`
##### Bug fixes
- When loading an MkDocs config, mike now runs the `startup` and `shutdown`
events
***
### [`v2.0.0`](https://togithub.com/jimporter/mike/blob/HEAD/CHANGES.md#v200-2023-11-02)
[Compare Source](https://togithub.com/jimporter/mike/compare/v1.1.2...v2.0.0)
##### New features
- Add support for applying arbitrary properties to documentation versions
- Add support for hiding specific versions from the selector when using the
default themes
- Deploy aliases using symbolic links by default; this can be configured via
`--alias-type` on the command line or `alias_type` in the `mike` MkDocs plugin
- Avoid creating empty commits by default; if you want empty commits, pass
`--allow-empty`
- Look for both `mkdocs.yml` and `mkdocs.yaml` configuration files
- Support `GIT_COMMITTER_(NAME|EMAIL|DATE)` when generating commits
- Allow specifying `alias_type`, `redirect_template`, and `deploy_prefix` in the
`mike` MkDocs plugin
- Add a `--debug` flag to help diagnose bugs with mike
- Port number is now optional for `--dev-addr` in `mike serve`, defaulting to
8000
##### Breaking changes
- `--prefix` is now `--deploy-prefix`
- `--no-redirect` is now `--alias-type=copy`
- `--ignore` is now `--ignore-remote-status`
- `-f` / `--force` 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)
- `--rebase` is no longer supported (instead of using this, it's better to use
Git to resolve any conflicts)
##### Bug fixes
- Aliases that are "similar" to preexisting versions (e.g. `1.0` and `1.0.0`)
can now be set properly
- Versions that *don't* start with a digit (or `v` and then a digit) are now
treated separately from other versions: they're considered development
versions, and thus newer than "ordinary" versions
- Fix retrieval of Git user name/email when using non-UTF8 encodings
- Fix version selector for `mkdocs` and `readthedocs` themes when
`use_directory_urls` is false
- When redirecting to another page, include the `?query`
- Ensure that aliases cannot be circularly defined
- Support file names with double-quotes or newlines
***
Configuration
📅 Schedule: Branch creation - "before 12pm every weekday" (UTC), Automerge - At any time (no schedule defined).
🚦 Automerge: Disabled by config. Please merge this manually once you are satisfied.
♻ Rebasing: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox.
🔕 Ignore: Close this PR and you won't be reminded about this update again.
[ ] If you want to rebase/retry this PR, check this box
This PR contains the following updates:
==1.1.2->==2.1.3Release Notes
jimporter/mike (mike)
### [`v2.1.3`](https://togithub.com/jimporter/mike/blob/HEAD/CHANGES.md#v213-2024-08-12) [Compare Source](https://togithub.com/jimporter/mike/compare/v2.1.2...v2.1.3) ##### Bug fixes - When deploying using a deploy prefix, only delete stale versions of the docs within that prefix *** ### [`v2.1.2`](https://togithub.com/jimporter/mike/blob/HEAD/CHANGES.md#v212-2024-06-23) [Compare Source](https://togithub.com/jimporter/mike/compare/v2.1.1...v2.1.2) ##### Bug fixes - Remove ambiguity of some Git commands so that file and branch names don't collide *** ### [`v2.1.1`](https://togithub.com/jimporter/mike/blob/HEAD/CHANGES.md#v211-2024-05-03) [Compare Source](https://togithub.com/jimporter/mike/compare/v2.1.0...v2.1.1) ##### Bug fixes - Support using environment variables for `INHERIT` when injecting the `mike` plugin into `mkdocs.yml` *** ### [`v2.1.0`](https://togithub.com/jimporter/mike/blob/HEAD/CHANGES.md#v210-2024-05-01) [Compare Source](https://togithub.com/jimporter/mike/compare/v2.0.0...v2.1.0) ##### New features - When calling `set-default`, you can now pass `--allow-undefined` to set the default to a version that doesn't exist yet - Add global-level `-q` / `--quiet` option to suppress warning messages - Add support for handling `!relative` in `mkdocs.yml` ##### Bug fixes - When loading an MkDocs config, mike now runs the `startup` and `shutdown` events *** ### [`v2.0.0`](https://togithub.com/jimporter/mike/blob/HEAD/CHANGES.md#v200-2023-11-02) [Compare Source](https://togithub.com/jimporter/mike/compare/v1.1.2...v2.0.0) ##### New features - Add support for applying arbitrary properties to documentation versions - Add support for hiding specific versions from the selector when using the default themes - Deploy aliases using symbolic links by default; this can be configured via `--alias-type` on the command line or `alias_type` in the `mike` MkDocs plugin - Avoid creating empty commits by default; if you want empty commits, pass `--allow-empty` - Look for both `mkdocs.yml` and `mkdocs.yaml` configuration files - Support `GIT_COMMITTER_(NAME|EMAIL|DATE)` when generating commits - Allow specifying `alias_type`, `redirect_template`, and `deploy_prefix` in the `mike` MkDocs plugin - Add a `--debug` flag to help diagnose bugs with mike - Port number is now optional for `--dev-addr` in `mike serve`, defaulting to 8000 ##### Breaking changes - `--prefix` is now `--deploy-prefix` - `--no-redirect` is now `--alias-type=copy` - `--ignore` is now `--ignore-remote-status` - `-f` / `--force` 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) - `--rebase` is no longer supported (instead of using this, it's better to use Git to resolve any conflicts) ##### Bug fixes - Aliases that are "similar" to preexisting versions (e.g. `1.0` and `1.0.0`) can now be set properly - Versions that *don't* start with a digit (or `v` and then a digit) are now treated separately from other versions: they're considered development versions, and thus newer than "ordinary" versions - Fix retrieval of Git user name/email when using non-UTF8 encodings - Fix version selector for `mkdocs` and `readthedocs` themes when `use_directory_urls` is false - When redirecting to another page, include the `?query` - Ensure that aliases cannot be circularly defined - Support file names with double-quotes or newlines ***Configuration
📅 Schedule: Branch creation - "before 12pm every weekday" (UTC), Automerge - At any time (no schedule defined).
🚦 Automerge: Disabled by config. Please merge this manually once you are satisfied.
♻ Rebasing: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox.
🔕 Ignore: Close this PR and you won't be reminded about this update again.
This PR was generated by Mend Renovate. View the repository job log.