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

build(deps-dev): bump mike from 0.6.0 to 1.0.0 #447

Closed
wants to merge 1 commit into from

Conversation

dependabot[bot]
Copy link
Contributor

@dependabot dependabot bot commented on behalf of github May 29, 2021

Bumps mike from 0.6.0 to 1.0.0.

Release notes

Sourced from mike's releases.

v1.0.0

New features

  • Remove mike install-extras and replace it with an MkDocs plugin; if you previously used install-extras, be sure to remove the added JS/CSS from your docs directory
  • When deploying aliases, deploy redirect pages to the real version by default; pass --no-redirect to deploy copies
  • Improve the default redirect template to support redirection when the user has disabled JavaScript
  • Allow deploying docs to a subdirectory within the target branch via --prefix
  • Add support for custom templates with mike set-default
  • Read from remote_branch and remote_name if set in mkdocs.yml
  • Allow updating an existing alias with mike alias -u

Breaking changes

  • Require Python 3.6+
  • Remove support for installing extras for material theme since material now has [built-in support][material-mike] for mike

Bug fixes

  • Canonical URLs in generated documentation now point to the correct location
  • mike alias now checks for existing aliases to prevent erroneously setting an alias for two different versions
  • Replace packaging dependency with verspec for future stability
  • Validate version and alias names to ensure they're non-empty and don't contain a directory separator
Changelog

Sourced from mike's changelog.

v1.0.0 (2021-04-10)

New features

  • Remove mike install-extras and replace it with an MkDocs plugin; if you previously used install-extras, be sure to remove the added JS/CSS from your docs directory
  • When deploying aliases, deploy redirect pages to the real version by default; pass --no-redirect to deploy copies
  • Improve the default redirect template to support redirection when the user has disabled JavaScript
  • Allow deploying docs to a subdirectory within the target branch via --prefix
  • Add support for custom templates with mike set-default
  • Read from remote_branch and remote_name if set in mkdocs.yml
  • Allow updating an existing alias with mike alias -u

Breaking changes

  • Require Python 3.6+
  • Remove support for installing extras for material theme since material now has built-in support for mike

Bug fixes

  • Canonical URLs in generated documentation now point to the correct location
  • mike alias now checks for existing aliases to prevent erroneously setting an alias for two different versions
  • Replace packaging dependency with verspec for future stability
  • Validate version and alias names to ensure they're non-empty and don't contain a directory separator

v0.5.5 (2020-11-08)

Bug fixes

  • Add support for mkdocs.yml files using !!python tags

v0.5.3 (2020-06-23)

Bug fixes

  • Fix some cases of material theme's version selector failing to load
  • Add support for material v5.0+

v0.5.2 (2020-05-23)

New features

... (truncated)

Commits
  • 09962b6 Update version to 1.0.0
  • 2961733 Validate version and alias names
  • 732a2de Turn deploy into a context-managed function
  • 1b272a0 Slight improvements to error reporting
  • d119286 Improve behavior of updating aliases
  • d60c381 Add help messages for all the subcommands
  • bd47075 Add tests for retrieving use_directory_urls from mkdocs.yml
  • 05eb98c Respect use_directory_urls when generating redirects for an alias
  • 79827d4 Add trailing slash when redirecting to directories; resolves #46
  • ba544cd Provide a more useful message when invoked with no arguments; resolves #45
  • 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 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 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 labels May 29, 2021
@pull-request-size pull-request-size bot added the size/M Denotes a PR that changes 30-99 lines, ignoring generated files. label May 29, 2021
@codecov-commenter
Copy link

codecov-commenter commented May 29, 2021

Codecov Report

Merging #447 (77e4003) into develop (7e9c7b7) will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff            @@
##           develop     #447   +/-   ##
========================================
  Coverage    99.90%   99.90%           
========================================
  Files          104      104           
  Lines         4193     4193           
  Branches       205      205           
========================================
  Hits          4189     4189           
  Misses           1        1           
  Partials         3        3           

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 7e9c7b7...77e4003. Read the comment docs.

@heitorlessa
Copy link
Contributor

@Mergifyio refresh

@dependabot dependabot bot force-pushed the dependabot/pip/develop/mike-1.0.0 branch from 471e67f to 308954d Compare May 29, 2021 19:35
@michaelbrewer
Copy link
Contributor

@heitorlessa a new version of mike (haha..)

@dependabot dependabot bot force-pushed the dependabot/pip/develop/mike-1.0.0 branch 2 times, most recently from a9f064f to 7d5a49f Compare May 31, 2021 19:54
@dependabot dependabot bot force-pushed the dependabot/pip/develop/mike-1.0.0 branch from 7d5a49f to 77e4003 Compare May 31, 2021 19:55
@dependabot @github
Copy link
Contributor Author

dependabot bot commented on behalf of github Jun 1, 2021

Superseded by #453.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
dependencies Pull requests that update a dependency file do-not-merge size/M Denotes a PR that changes 30-99 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants