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

Bump mkdocs-table-reader-plugin from 2.2.2 to 3.0.1 #613

Merged
merged 1 commit into from
Sep 11, 2024

Conversation

dependabot[bot]
Copy link
Contributor

@dependabot dependabot bot commented on behalf of github Aug 19, 2024

Bumps mkdocs-table-reader-plugin from 2.2.2 to 3.0.1.

Release notes

Sourced from mkdocs-table-reader-plugin's releases.

table-reader v3.0.1

What's Changed

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

table-reader v3.0.0

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

Commits
  • 5dcaeca Merge pull request #69 from timvink/add_support_for_indentation_in_macros
  • 572b702 Add support for fixing indentation in jinja
  • 9f6b419 Merge pull request #68 from timvink/v2_version
  • 80928d8 bump to v3.0.0
  • b94523e ruff format
  • 3fd8d72 fix codespell action
  • 0329d2d Update docs and add deprecation warnings, update gh actions
  • ba88bee Update docs and add deprecation warnings
  • 2cdc786 Refactor for compatibility with macros
  • 74817da Update test
  • 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 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 Aug 19, 2024
Bumps [mkdocs-table-reader-plugin](https://github.com/timvink/mkdocs-table-reader-plugin) from 2.2.2 to 3.0.1.
- [Release notes](https://github.com/timvink/mkdocs-table-reader-plugin/releases)
- [Commits](timvink/mkdocs-table-reader-plugin@v2.2.2...v3.0.1)

---
updated-dependencies:
- dependency-name: mkdocs-table-reader-plugin
  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/mkdocs-table-reader-plugin-3.0.1 branch from dd515b7 to 10d1b9c Compare August 21, 2024 17:40
Copy link
Contributor

@ahouseholder ahouseholder left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The release notes for mkdocs-table-reader-plugin mentioned some potentially breaking changes, but I've reviewed mkdocs.yml and it looks like we weren't dependent on any of the breaking changes so given that this passes the build tests I think it's ok to merge.

@ahouseholder ahouseholder merged commit 833c86f into main Sep 11, 2024
3 checks passed
@ahouseholder ahouseholder deleted the dependabot/pip/mkdocs-table-reader-plugin-3.0.1 branch September 11, 2024 13:27
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.

1 participant