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 mkdocs-table-reader-plugin to v3 #1490

Merged
merged 1 commit into from
Aug 17, 2024

Conversation

renovate[bot]
Copy link
Contributor

@renovate renovate bot commented Aug 15, 2024

Mend Renovate

This PR contains the following updates:

Package Change Age Adoption Passing Confidence
mkdocs-table-reader-plugin ^2.0 -> ^3.0.0 age adoption passing confidence

Release Notes

timvink/mkdocs-table-reader-plugin (mkdocs-table-reader-plugin)

v3.0.1: table-reader v3.0.1

Compare Source

What's Changed

Full Changelog: timvink/mkdocs-table-reader-plugin@v3.0.0...v3.0.1

v3.0.0: table-reader v3.0.0

Compare Source

What's Changed

  • table-reader is now compatible with mkdocs-macros-plugin, which means you can dynamically insert tables using jinja2 syntax.
  • The base_path option has now been deprecated (and will log a warning when used). Now by default, the config_dir (path to your mkdocs.yml file) and docs_dir (path to your docs/ dir) will always be searched when looking for a table file path
  • The search_page_directory option has now been deprecated (and will log a warning when used). The markdown page's source file directory will always be searched when looking for a table file.
Breaking changes / upgrading guide
  • Remove base_path and search_page_directory from your mkdocs.yml options.
### mkdocs.yml
plugins:
-    - table-reader:
-        base_path: docs_dir
-        search_page_directory: True
+    - table-reader
  • In your mkdocs.yml file, the macros plugin should be defined before the table-reader plugin (previously this was after)
### mkdocs.yml
plugins:
-    - table-reader
-    - macros
+    - macros
+    - table-reader

Full Changelog: timvink/mkdocs-table-reader-plugin@v2.2.2...v3.0.0


Configuration

📅 Schedule: Branch creation - At any time (no schedule defined), 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 was generated by Mend Renovate. View the repository job log.

@renovate renovate bot requested a review from Anselmoo as a code owner August 15, 2024 14:45
Copy link

Review changes with SemanticDiff.

@github-actions github-actions bot added maintenance Maintenance & Security dependencies Pull requests that update a dependency file root labels Aug 15, 2024
Copy link

Copy link

codecov bot commented Aug 15, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 100.00%. Comparing base (0628149) to head (98b4e06).
Report is 2 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff            @@
##              main     #1490   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files           44        44           
  Lines         4467      4467           
=========================================
  Hits          4467      4467           
Flag Coverage Δ
unittests 100.00% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

@Anselmoo Anselmoo merged commit d26ec4b into main Aug 17, 2024
33 checks passed
@Anselmoo Anselmoo deleted the renovate/mkdocs-table-reader-plugin-3.x branch August 17, 2024 05: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 maintenance Maintenance & Security root size/XS
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant