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): Bump mkdocs from 1.3.1 to 1.4.0 #1434

Closed
wants to merge 1 commit into from

Conversation

dependabot[bot]
Copy link
Contributor

@dependabot dependabot bot commented on behalf of github Oct 3, 2022

Bumps mkdocs from 1.3.1 to 1.4.0.

Release notes

Sourced from mkdocs's releases.

1.4.0

Feature upgrades

Hooks (#2978)

The new hooks: config allows you to add plugin-like event handlers from local Python files, without needing to set up and install an actual plugin.

See documentation.

edit_uri flexibility (#2927)

There is a new edit_uri_template: config.
It works like edit_uri but more generally covers ways to construct an edit URL.
See documentation.

Additionally, the edit_uri functionality will now fully work even if repo_url is omitted (#2928)

Upgrades for plugin developers

NOTE: This release has big changes to the implementation of plugins and their configs. But, the intention is to have zero breaking changes in all reasonably common use cases. Or at the very least if a code fix is required, there should always be a way to stay compatible with older MkDocs versions. Please report if this release breaks something.

Customize event order for plugin event handlers (#2973)

Plugins can now choose to set a priority value for their event handlers. This can override the old behavior where for each event type, the handlers are called in the order that their plugins appear in the plugins config.

If this is set, events with higher priority are called first. Events without a chosen priority get a default of 0. Events that have the same priority are ordered as they appear in the config.

Recommended priority values: 100 "first", 50 "early", 0 "default", -50 "late", -100 "last".
As different plugins discover more precise relations to each other, the values should be further tweaked.

See documentation.

New events that persist across builds in mkdocs serve (#2972)

The new events are on_startup and on_shutdown. They run at the very beginning and very end of an mkdocs invocation.
on_startup also receives information on how mkdocs was invoked (e.g. serve --dirtyreload).

See documentation.

Replace File.src_path to not deal with backslashes (#2930)

The property src_path uses backslashes on Windows, which doesn't make sense as it's a virtual path.
To not make a breaking change, there's no change to how this property is used, but now you should:

  • Use File.src_uri instead of File.src_path
  • and File.dest_uri instead of File.dest_path.

These consistently use forward slashes, and are now the definitive source that MkDocs itself uses.

... (truncated)

Commits
  • 927ee26 Release 1.4.0 (#2986)
  • 5cce501 Merge pull request #2962 from mkdocs/meta
  • 5015fa7 Add examples of class-based schema with ListOfItems
  • cc627f7 Prevent wrapping into Optional when the option has a default
  • aeffe61 Change config_options.URL's default from '' to None
  • 5156947 Add a test for subclassing a config schema
  • ff8552a Add tests for new class-based configs
  • 6d8c4d1 Preserve a copy of config_options_tests before reworking it
  • 452f56c Move config_options_tests.py before reworking it
  • cf9d237 Change ListOfItems' "default default" from [] to None
  • 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 requested a review from a team as a code owner October 3, 2022 03:01
@dependabot dependabot bot added dependencies Pull requests that update a dependency file python Pull requests that update Python code labels Oct 3, 2022
@prcr
Copy link
Contributor

prcr commented Oct 3, 2022

@dependabot recreate

@dependabot dependabot bot force-pushed the dependabot/pip/mkdocs-1.4.0 branch from d95ecf2 to 824d84f Compare October 3, 2022 13:25
@prcr
Copy link
Contributor

prcr commented Oct 3, 2022

We must wait until a new release of mkdocs-rss-plugin that supports mkdocs 1.4.0.

@dependabot dependabot bot force-pushed the dependabot/pip/mkdocs-1.4.0 branch 3 times, most recently from 16e9428 to 2b064df Compare October 3, 2022 17:22
@prcr prcr enabled auto-merge (squash) October 3, 2022 17:25
@prcr prcr self-requested a review October 4, 2022 09:57
@prcr prcr disabled auto-merge October 4, 2022 12:57
@prcr
Copy link
Contributor

prcr commented Oct 4, 2022

@dependabot recreate

@dependabot dependabot bot force-pushed the dependabot/pip/mkdocs-1.4.0 branch from f200daa to 35b64eb Compare October 4, 2022 12:57
Bumps [mkdocs](https://github.com/mkdocs/mkdocs) from 1.3.1 to 1.4.0.
- [Release notes](https://github.com/mkdocs/mkdocs/releases)
- [Commits](mkdocs/mkdocs@1.3.1...1.4.0)

---
updated-dependencies:
- dependency-name: mkdocs
  dependency-type: direct:production
  update-type: version-update:semver-minor
...

Signed-off-by: dependabot[bot] <support@github.com>
@dependabot dependabot bot force-pushed the dependabot/pip/mkdocs-1.4.0 branch from 35b64eb to 3c0b18c Compare October 10, 2022 09:37
@prcr prcr marked this pull request as draft October 11, 2022 11:16
@prcr
Copy link
Contributor

prcr commented Oct 15, 2022

Waiting for a new version of mkdocs-include-markdown-plugin that includes mondeja/mkdocs-include-markdown-plugin#130.

@dependabot @github
Copy link
Contributor Author

dependabot bot commented on behalf of github Oct 17, 2022

Superseded by #1461.

@dependabot dependabot bot closed this Oct 17, 2022
@dependabot dependabot bot deleted the dependabot/pip/mkdocs-1.4.0 branch October 17, 2022 03:02
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 python Pull requests that update Python code
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

1 participant