Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore(deps): update dependency mike to v2 #323

Open
wants to merge 1 commit into
base: dev
Choose a base branch
from

Conversation

renovate[bot]
Copy link
Contributor

@renovate renovate bot commented Jan 2, 2024

Mend Renovate

This PR contains the following updates:

Package Change Age Adoption Passing Confidence
mike ==1.1.2 -> ==2.1.1 age adoption passing confidence

Release Notes

jimporter/mike (mike)

v2.1.1

Compare Source

Bug fixes
  • Support using environment variables for INHERIT when injecting the mike
    plugin into mkdocs.yml

v2.1.0

Compare Source

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

Compare Source

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 has been generated by Mend Renovate. View repository job log here.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

0 participants