Skip to content
This repository was archived by the owner on Apr 13, 2025. It is now read-only.

Bump mike from 1.1.2 to 2.0.0 #177

Merged
merged 1 commit into from
Dec 1, 2023
Merged

Conversation

dependabot[bot]
Copy link
Contributor

@dependabot dependabot bot commented on behalf of github Dec 1, 2023

Bumps mike from 1.1.2 to 2.0.0.

Release notes

Sourced from mike's releases.

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
Changelog

Sourced from mike's changelog.

v2.0.0 (2023-11-02)

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

Commits
  • 44cc579 Update version to 2.0.0
  • f9af52d Yet more typos
  • 8b4281c Fix invalid JSONPath syntax example
  • 875bf58 More typos
  • 7a55bf3 Typo
  • 0481f92 Allow new versions to replace existing aliases when --update-aliases is set
  • 6de61fa Fix poor wording in changes
  • 367fbd0 Add support for hidden versions in the built-in themes; resolves #187
  • c69d11f Allow setting arbitrary properties for versions; resolves #138
  • 27e7cba Add properties to VersionInfo
  • Additional commits viewable in compare view

Dependabot compatibility score

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 will merge this PR once CI passes on it, as requested by @daniel0611.


Dependabot commands and options

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)

@dependabot dependabot bot added dependencies Pull requests that update a dependency file python Pull requests that update Python code labels Dec 1, 2023
@dependabot dependabot bot force-pushed the dependabot/pip/mike-2.0.0 branch from eff13b7 to 31a5947 Compare December 1, 2023 12:53
@hlxid
Copy link
Member

hlxid commented Dec 1, 2023

None of the breaking changes do affect our workflow, so merging this shouldn't create any problems.

@dependabot squash and merge

Bumps [mike](https://github.com/jimporter/mike) from 1.1.2 to 2.0.0.
- [Release notes](https://github.com/jimporter/mike/releases)
- [Changelog](https://github.com/jimporter/mike/blob/master/CHANGES.md)
- [Commits](jimporter/mike@v1.1.2...v2.0.0)

---
updated-dependencies:
- dependency-name: mike
  dependency-type: direct:production
  update-type: version-update:semver-major
...

Signed-off-by: dependabot[bot] <support@github.com>
@dependabot dependabot bot force-pushed the dependabot/pip/mike-2.0.0 branch from 31a5947 to 4ec21fe Compare December 1, 2023 13:38
@dependabot dependabot bot merged commit bfb8ea3 into main Dec 1, 2023
@dependabot dependabot bot deleted the dependabot/pip/mike-2.0.0 branch December 1, 2023 13:58
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
dependencies Pull requests that update a dependency file python Pull requests that update Python code
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant