feat: add custom search command support #1653

hetangmodi-crest · 2025-03-21T11:58:56Z

Issue number: ADDON-76780

PR Type

What kind of change does this PR introduce?

Summary

Added support for custom search command. This PR contains the dev changes for custom search command.
Test case PR #1654

Changes

customSearchCommand tag has been added to the global configuration, allowing users to generate their custom search commands using ucc-gen build. Users will only need to define the logic for their command and update the customSearchCommand in globalConfig.

User experience

Users can now generate custom search commands using the ucc-gen build command. To do so, they need to define the command logic and update the globalConfig accordingly.

Checklist

If an item doesn't apply to your changes, leave it unchecked.

Review

self-review - I have performed a self-review of this change according to the development guidelines
Changes are documented. The documentation is understandable, examples work (more info)
PR title and description follows the contributing principles
meeting - I have scheduled a meeting or recorded a demo to explain these changes (if there is a video, put a link below and in the ticket)

Tests

See the testing doc.

Unit - tests have been added/modified to cover the changes
Smoke - tests have been added/modified to cover the changes
UI - tests have been added/modified to cover the changes
coverage - I have checked the code coverage of my changes (see more)

Demo/meeting:

Reviewers are encouraged to request meetings or demos if any part of the change is unclear

kkedziak-splunk · 2025-03-26T12:54:17Z

Similar to the previous PR, the minimal definition from the docs does not work.

Traceback (most recent call last):
  File "<string>", line 1, in <module>
  File "/Users/kkedziak/PycharmProjects/addonfactory-ucc-generator/splunk_add_on_ucc_framework/main.py", line 244, in main
    build.generate(
  File "/Users/kkedziak/PycharmProjects/addonfactory-ucc-generator/splunk_add_on_ucc_framework/commands/build.py", line 520, in generate
    if (command["requiredSearchAssistant"] is False) and (
KeyError: 'requiredSearchAssistant'

Please either change the expression to command.get("requiredSearchAssistant", False) or make it required in schema.json and update the docs.

#1655) **Issue number:** ADDON-78488 ### PR Type **What kind of change does this PR introduce?** * [ ] Feature * [ ] Bug Fix * [x] Refactoring (no functional or API changes) * [ ] Documentation Update * [ ] Maintenance (dependency updates, CI, etc.) ## Summary ### Changes This PR introduces a new method to initialize `GlobalConfig` instance - `from_file`. It accepts a path to the globalConfig file (can be JSON or YAML) and returns an instance of `GlobalConfig`. It's a preparation work for #1625 PR. ### User experience N/A ## Checklist If an item doesn't apply to your changes, leave it unchecked. ### Review * [x] self-review - I have performed a self-review of this change according to the [development guidelines](https://splunk.github.io/addonfactory-ucc-generator/contributing/#development-guidelines) * [ ] Changes are documented. The documentation is understandable, examples work [(more info)](https://splunk.github.io/addonfactory-ucc-generator/contributing/#documentation-guidelines) * [x] PR title and description follows the [contributing principles](https://splunk.github.io/addonfactory-ucc-generator/contributing/#pull-requests) * [ ] meeting - I have scheduled a meeting or recorded a demo to explain these changes (if there is a video, put a link below and in the ticket) ### Tests See [the testing doc](https://splunk.github.io/addonfactory-ucc-generator/contributing/#build-and-test). * [x] Unit - tests have been added/modified to cover the changes * [ ] Smoke - tests have been added/modified to cover the changes * [ ] UI - tests have been added/modified to cover the changes * [ ] coverage - I have checked the code coverage of my changes [(see more)](https://splunk.github.io/addonfactory-ucc-generator/contributing/#checking-the-code-coverage) **Demo/meeting:** *Reviewers are encouraged to request meetings or demos if any part of the change is unclear*

**Issue number:** N/A ### PR Type **What kind of change does this PR introduce?** * [ ] Feature * [ ] Bug Fix * [x] Refactoring (no functional or API changes) * [ ] Documentation Update * [ ] Maintenance (dependency updates, CI, etc.) ## Summary ### Changes Further simplification of `GlobalConfig` class, this PR removes `original_path` parameter from the `GlobalConfig`'s constructor. This would allow us to simply integrate `from_app_conf_and_app_manifest` to allow all TAs to have `globalConfig`. ### User experience N/A ## Checklist If an item doesn't apply to your changes, leave it unchecked. ### Review * [x] self-review - I have performed a self-review of this change according to the [development guidelines](https://splunk.github.io/addonfactory-ucc-generator/contributing/#development-guidelines) * [ ] Changes are documented. The documentation is understandable, examples work [(more info)](https://splunk.github.io/addonfactory-ucc-generator/contributing/#documentation-guidelines) * [x] PR title and description follows the [contributing principles](https://splunk.github.io/addonfactory-ucc-generator/contributing/#pull-requests) * [ ] meeting - I have scheduled a meeting or recorded a demo to explain these changes (if there is a video, put a link below and in the ticket) ### Tests See [the testing doc](https://splunk.github.io/addonfactory-ucc-generator/contributing/#build-and-test). * [x] Unit - tests have been added/modified to cover the changes * [ ] Smoke - tests have been added/modified to cover the changes * [ ] UI - tests have been added/modified to cover the changes * [x] coverage - I have checked the code coverage of my changes [(see more)](https://splunk.github.io/addonfactory-ucc-generator/contributing/#checking-the-code-coverage) **Demo/meeting:** *Reviewers are encouraged to request meetings or demos if any part of the change is unclear*

hetangmodi-crest · 2025-03-28T08:23:51Z

Please either change the expression to command.get("requiredSearchAssistant", False) or make it required in schema.json and update the docs.

Made the changes.

**Issue number:** ADDON-78488 ### PR Type **What kind of change does this PR introduce?** * [ ] Feature * [ ] Bug Fix * [ ] Refactoring (no functional or API changes) * [ ] Documentation Update * [x] Maintenance (dependency updates, CI, etc.) ## Summary ### Changes This PR introduces support for comparing `GlobalConfig` objects (`__eq__` implementation) and exposes `is_yaml` as a property. ### User experience N/A ## Checklist If an item doesn't apply to your changes, leave it unchecked. ### Review * [x] self-review - I have performed a self-review of this change according to the [development guidelines](https://splunk.github.io/addonfactory-ucc-generator/contributing/#development-guidelines) * [ ] Changes are documented. The documentation is understandable, examples work [(more info)](https://splunk.github.io/addonfactory-ucc-generator/contributing/#documentation-guidelines) * [x] PR title and description follows the [contributing principles](https://splunk.github.io/addonfactory-ucc-generator/contributing/#pull-requests) * [ ] meeting - I have scheduled a meeting or recorded a demo to explain these changes (if there is a video, put a link below and in the ticket) ### Tests See [the testing doc](https://splunk.github.io/addonfactory-ucc-generator/contributing/#build-and-test). * [x] Unit - tests have been added/modified to cover the changes * [ ] Smoke - tests have been added/modified to cover the changes * [ ] UI - tests have been added/modified to cover the changes * [ ] coverage - I have checked the code coverage of my changes [(see more)](https://splunk.github.io/addonfactory-ucc-generator/contributing/#checking-the-code-coverage) **Demo/meeting:** *Reviewers are encouraged to request meetings or demos if any part of the change is unclear*

This PR contains the following updates: | Package | Change | Age | Adoption | Passing | Confidence | |---|---|---|---|---|---| | [PyYAML](https://pyyaml.org/) ([source](https://github.com/yaml/pyyaml)) | `6.0.1` -> `6.0.2` | [![age](https://developer.mend.io/api/mc/badges/age/pypi/pyyaml/6.0.2?slim=true)](https://docs.renovatebot.com/merge-confidence/) | [![adoption](https://developer.mend.io/api/mc/badges/adoption/pypi/pyyaml/6.0.2?slim=true)](https://docs.renovatebot.com/merge-confidence/) | [![passing](https://developer.mend.io/api/mc/badges/compatibility/pypi/pyyaml/6.0.1/6.0.2?slim=true)](https://docs.renovatebot.com/merge-confidence/) | [![confidence](https://developer.mend.io/api/mc/badges/confidence/pypi/pyyaml/6.0.1/6.0.2?slim=true)](https://docs.renovatebot.com/merge-confidence/) | | [dunamai](https://github.com/mtkennerly/dunamai) | `1.23.0` -> `1.23.1` | [![age](https://developer.mend.io/api/mc/badges/age/pypi/dunamai/1.23.1?slim=true)](https://docs.renovatebot.com/merge-confidence/) | [![adoption](https://developer.mend.io/api/mc/badges/adoption/pypi/dunamai/1.23.1?slim=true)](https://docs.renovatebot.com/merge-confidence/) | [![passing](https://developer.mend.io/api/mc/badges/compatibility/pypi/dunamai/1.23.0/1.23.1?slim=true)](https://docs.renovatebot.com/merge-confidence/) | [![confidence](https://developer.mend.io/api/mc/badges/confidence/pypi/dunamai/1.23.0/1.23.1?slim=true)](https://docs.renovatebot.com/merge-confidence/) | | [importlib-metadata](https://github.com/python/importlib_metadata) | `6.7.0` -> `6.11.0` | [![age](https://developer.mend.io/api/mc/badges/age/pypi/importlib-metadata/6.11.0?slim=true)](https://docs.renovatebot.com/merge-confidence/) | [![adoption](https://developer.mend.io/api/mc/badges/adoption/pypi/importlib-metadata/6.11.0?slim=true)](https://docs.renovatebot.com/merge-confidence/) | [![passing](https://developer.mend.io/api/mc/badges/compatibility/pypi/importlib-metadata/6.7.0/6.11.0?slim=true)](https://docs.renovatebot.com/merge-confidence/) | [![confidence](https://developer.mend.io/api/mc/badges/confidence/pypi/importlib-metadata/6.7.0/6.11.0?slim=true)](https://docs.renovatebot.com/merge-confidence/) | | [jsonschema](https://github.com/python-jsonschema/jsonschema) ([changelog](https://github.com/python-jsonschema/jsonschema/blob/main/CHANGELOG.rst)) | `4.17.3` -> `4.23.0` | [![age](https://developer.mend.io/api/mc/badges/age/pypi/jsonschema/4.23.0?slim=true)](https://docs.renovatebot.com/merge-confidence/) | [![adoption](https://developer.mend.io/api/mc/badges/adoption/pypi/jsonschema/4.23.0?slim=true)](https://docs.renovatebot.com/merge-confidence/) | [![passing](https://developer.mend.io/api/mc/badges/compatibility/pypi/jsonschema/4.17.3/4.23.0?slim=true)](https://docs.renovatebot.com/merge-confidence/) | [![confidence](https://developer.mend.io/api/mc/badges/confidence/pypi/jsonschema/4.17.3/4.23.0?slim=true)](https://docs.renovatebot.com/merge-confidence/) | | [mkdocs](https://github.com/mkdocs/mkdocs) ([changelog](https://www.mkdocs.org/about/release-notes/)) | `1.5.3` -> `1.6.1` | [![age](https://developer.mend.io/api/mc/badges/age/pypi/mkdocs/1.6.1?slim=true)](https://docs.renovatebot.com/merge-confidence/) | [![adoption](https://developer.mend.io/api/mc/badges/adoption/pypi/mkdocs/1.6.1?slim=true)](https://docs.renovatebot.com/merge-confidence/) | [![passing](https://developer.mend.io/api/mc/badges/compatibility/pypi/mkdocs/1.5.3/1.6.1?slim=true)](https://docs.renovatebot.com/merge-confidence/) | [![confidence](https://developer.mend.io/api/mc/badges/confidence/pypi/mkdocs/1.5.3/1.6.1?slim=true)](https://docs.renovatebot.com/merge-confidence/) | | [mkdocs-material](https://github.com/squidfunk/mkdocs-material) ([changelog](https://squidfunk.github.io/mkdocs-material/changelog/)) | `9.2.7` -> `9.6.10` | [![age](https://developer.mend.io/api/mc/badges/age/pypi/mkdocs-material/9.6.10?slim=true)](https://docs.renovatebot.com/merge-confidence/) | [![adoption](https://developer.mend.io/api/mc/badges/adoption/pypi/mkdocs-material/9.6.10?slim=true)](https://docs.renovatebot.com/merge-confidence/) | [![passing](https://developer.mend.io/api/mc/badges/compatibility/pypi/mkdocs-material/9.2.7/9.6.10?slim=true)](https://docs.renovatebot.com/merge-confidence/) | [![confidence](https://developer.mend.io/api/mc/badges/confidence/pypi/mkdocs-material/9.2.7/9.6.10?slim=true)](https://docs.renovatebot.com/merge-confidence/) | | [mkdocs-print-site-plugin](https://github.com/timvink/mkdocs-print-site-plugin) | `2.3.6` -> `2.7.1` | [![age](https://developer.mend.io/api/mc/badges/age/pypi/mkdocs-print-site-plugin/2.7.1?slim=true)](https://docs.renovatebot.com/merge-confidence/) | [![adoption](https://developer.mend.io/api/mc/badges/adoption/pypi/mkdocs-print-site-plugin/2.7.1?slim=true)](https://docs.renovatebot.com/merge-confidence/) | [![passing](https://developer.mend.io/api/mc/badges/compatibility/pypi/mkdocs-print-site-plugin/2.3.6/2.7.1?slim=true)](https://docs.renovatebot.com/merge-confidence/) | [![confidence](https://developer.mend.io/api/mc/badges/confidence/pypi/mkdocs-print-site-plugin/2.3.6/2.7.1?slim=true)](https://docs.renovatebot.com/merge-confidence/) | | [mkdocstrings](https://github.com/mkdocstrings/mkdocstrings) ([changelog](https://mkdocstrings.github.io/changelog)) | `0.22.0` -> `0.29.0` | [![age](https://developer.mend.io/api/mc/badges/age/pypi/mkdocstrings/0.29.0?slim=true)](https://docs.renovatebot.com/merge-confidence/) | [![adoption](https://developer.mend.io/api/mc/badges/adoption/pypi/mkdocstrings/0.29.0?slim=true)](https://docs.renovatebot.com/merge-confidence/) | [![passing](https://developer.mend.io/api/mc/badges/compatibility/pypi/mkdocstrings/0.22.0/0.29.0?slim=true)](https://docs.renovatebot.com/merge-confidence/) | [![confidence](https://developer.mend.io/api/mc/badges/confidence/pypi/mkdocstrings/0.22.0/0.29.0?slim=true)](https://docs.renovatebot.com/merge-confidence/) | | [packaging](https://github.com/pypa/packaging) | `24.0` -> `24.2` | [![age](https://developer.mend.io/api/mc/badges/age/pypi/packaging/24.2?slim=true)](https://docs.renovatebot.com/merge-confidence/) | [![adoption](https://developer.mend.io/api/mc/badges/adoption/pypi/packaging/24.2?slim=true)](https://docs.renovatebot.com/merge-confidence/) | [![passing](https://developer.mend.io/api/mc/badges/compatibility/pypi/packaging/24.0/24.2?slim=true)](https://docs.renovatebot.com/merge-confidence/) | [![confidence](https://developer.mend.io/api/mc/badges/confidence/pypi/packaging/24.0/24.2?slim=true)](https://docs.renovatebot.com/merge-confidence/) | | pytest-splunk-addon-ui-smartx | `5.3.2` -> `5.3.3` | [![age](https://developer.mend.io/api/mc/badges/age/pypi/pytest-splunk-addon-ui-smartx/5.3.3?slim=true)](https://docs.renovatebot.com/merge-confidence/) | [![adoption](https://developer.mend.io/api/mc/badges/adoption/pypi/pytest-splunk-addon-ui-smartx/5.3.3?slim=true)](https://docs.renovatebot.com/merge-confidence/) | [![passing](https://developer.mend.io/api/mc/badges/compatibility/pypi/pytest-splunk-addon-ui-smartx/5.3.2/5.3.3?slim=true)](https://docs.renovatebot.com/merge-confidence/) | [![confidence](https://developer.mend.io/api/mc/badges/confidence/pypi/pytest-splunk-addon-ui-smartx/5.3.2/5.3.3?slim=true)](https://docs.renovatebot.com/merge-confidence/) | | [xmldiff](https://github.com/Shoobx/xmldiff) | `2.6.3` -> `2.7.0` | [![age](https://developer.mend.io/api/mc/badges/age/pypi/xmldiff/2.7.0?slim=true)](https://docs.renovatebot.com/merge-confidence/) | [![adoption](https://developer.mend.io/api/mc/badges/adoption/pypi/xmldiff/2.7.0?slim=true)](https://docs.renovatebot.com/merge-confidence/) | [![passing](https://developer.mend.io/api/mc/badges/compatibility/pypi/xmldiff/2.6.3/2.7.0?slim=true)](https://docs.renovatebot.com/merge-confidence/) | [![confidence](https://developer.mend.io/api/mc/badges/confidence/pypi/xmldiff/2.6.3/2.7.0?slim=true)](https://docs.renovatebot.com/merge-confidence/) | --- ### Release Notes <details> <summary>yaml/pyyaml (PyYAML)</summary> ### [`v6.0.2`](https://github.com/yaml/pyyaml/releases/tag/6.0.2) [Compare Source](https://github.com/yaml/pyyaml/compare/6.0.1...6.0.2) #### What's Changed - Support for Cython 3.x and Python 3.13. **Full Changelog**: https://github.com/yaml/pyyaml/compare/6.0.1...6.0.2 </details> <details> <summary>mtkennerly/dunamai (dunamai)</summary> ### [`v1.23.1`](https://github.com/mtkennerly/dunamai/blob/HEAD/CHANGELOG.md#v1231-2025-03-20) [Compare Source](https://github.com/mtkennerly/dunamai/compare/v1.23.0...v1.23.1) - Fixed: `Version.__lt__` checked if *all* fields were less than the other instance, rather than using the proper field precedence and version ordering. </details> <details> <summary>python/importlib_metadata (importlib-metadata)</summary> ### [`v6.11.0`](https://github.com/python/importlib_metadata/compare/v6.10.0...v6.11.0) [Compare Source](https://github.com/python/importlib_metadata/compare/v6.10.0...v6.11.0) ### [`v6.10.0`](https://github.com/python/importlib_metadata/compare/v6.9.0...v6.10.0) [Compare Source](https://github.com/python/importlib_metadata/compare/v6.9.0...v6.10.0) ### [`v6.9.0`](https://github.com/python/importlib_metadata/compare/v6.8.0...v6.9.0) [Compare Source](https://github.com/python/importlib_metadata/compare/v6.8.0...v6.9.0) ### [`v6.8.0`](https://github.com/python/importlib_metadata/compare/v6.7.0...v6.8.0) [Compare Source](https://github.com/python/importlib_metadata/compare/v6.7.0...v6.8.0) </details> <details> <summary>python-jsonschema/jsonschema (jsonschema)</summary> ### [`v4.23.0`](https://github.com/python-jsonschema/jsonschema/blob/HEAD/CHANGELOG.rst#v4230) [Compare Source](https://github.com/python-jsonschema/jsonschema/compare/v4.22.0...v4.23.0) \======= - Do not reorder dictionaries (schemas, instances) that are printed as part of validation errors. - Declare support for Py3.13 ### [`v4.22.0`](https://github.com/python-jsonschema/jsonschema/blob/HEAD/CHANGELOG.rst#v4220) [Compare Source](https://github.com/python-jsonschema/jsonschema/compare/v4.21.1...v4.22.0) \======= - Improve `best_match` (and thereby error messages from `jsonschema.validate`) in cases where there are multiple *sibling* errors from applying `anyOf` / `allOf` -- i.e. when multiple elements of a JSON array have errors, we now do prefer showing errors from earlier elements rather than simply showing an error for the full array ([#1250](https://github.com/python-jsonschema/jsonschema/issues/1250)). - (Micro-)optimize equality checks when comparing for JSON Schema equality by first checking for object identity, as `==` would. ### [`v4.21.1`](https://github.com/python-jsonschema/jsonschema/blob/HEAD/CHANGELOG.rst#v4211) [Compare Source](https://github.com/python-jsonschema/jsonschema/compare/v4.21.0...v4.21.1) \======= - Slightly speed up the `contains` keyword by removing some unnecessary validator (re-)creation. ### [`v4.21.0`](https://github.com/python-jsonschema/jsonschema/blob/HEAD/CHANGELOG.rst#v4210) [Compare Source](https://github.com/python-jsonschema/jsonschema/compare/v4.20.0...v4.21.0) \======= - Fix the behavior of `enum` in the presence of `0` or `1` to properly consider `True` and `False` unequal ([#1208](https://github.com/python-jsonschema/jsonschema/issues/1208)). - Special case the error message for `{min,max}{Items,Length,Properties}` when they're checking for emptiness rather than true length. ### [`v4.20.0`](https://github.com/python-jsonschema/jsonschema/blob/HEAD/CHANGELOG.rst#v4200) [Compare Source](https://github.com/python-jsonschema/jsonschema/compare/v4.19.2...v4.20.0) \======= - Properly consider items (and properties) to be evaluated by `unevaluatedItems` (resp. `unevaluatedProperties`) when behind a `$dynamicRef` as specified by the 2020 and 2019 specifications. - `jsonschema.exceptions.ErrorTree.__setitem__` is now deprecated. More broadly, in general users of `jsonschema` should never be mutating objects owned by the library. ### [`v4.19.2`](https://github.com/python-jsonschema/jsonschema/blob/HEAD/CHANGELOG.rst#v4192) [Compare Source](https://github.com/python-jsonschema/jsonschema/compare/v4.19.1...v4.19.2) \======= - Fix the error message for additional items when used with heterogeneous arrays. - Don't leak the `additionalItems` keyword into JSON Schema draft 2020-12, where it was replaced by `items`. ### [`v4.19.1`](https://github.com/python-jsonschema/jsonschema/blob/HEAD/CHANGELOG.rst#v4191) [Compare Source](https://github.com/python-jsonschema/jsonschema/compare/v4.19.0...v4.19.1) \======= - Single label hostnames are now properly considered valid according to the `hostname` format. This is the behavior specified by the relevant RFC (1123). IDN hostname behavior was already correct. ### [`v4.19.0`](https://github.com/python-jsonschema/jsonschema/blob/HEAD/CHANGELOG.rst#v4190) [Compare Source](https://github.com/python-jsonschema/jsonschema/compare/v4.18.6...v4.19.0) \======= - Importing the `Validator` protocol directly from the package root is deprecated. Import it from `jsonschema.protocols.Validator` instead. - Automatic retrieval of remote references (which is still deprecated) now properly succeeds even if the retrieved resource does not declare which version of JSON Schema it uses. Such resources are assumed to be 2020-12 schemas. This more closely matches the pre-referencing library behavior. ### [`v4.18.6`](https://github.com/python-jsonschema/jsonschema/blob/HEAD/CHANGELOG.rst#v4186) [Compare Source](https://github.com/python-jsonschema/jsonschema/compare/v4.18.5...v4.18.6) \======= - Set a `jsonschema` specific user agent when automatically retrieving remote references (which is deprecated). ### [`v4.18.5`](https://github.com/python-jsonschema/jsonschema/blob/HEAD/CHANGELOG.rst#v4185) [Compare Source](https://github.com/python-jsonschema/jsonschema/compare/v4.18.4...v4.18.5) \======= - Declare support for Py3.12 ### [`v4.18.4`](https://github.com/python-jsonschema/jsonschema/blob/HEAD/CHANGELOG.rst#v4184) [Compare Source](https://github.com/python-jsonschema/jsonschema/compare/v4.18.3...v4.18.4) \======= - Improve the hashability of wrapped referencing exceptions when they contain hashable data. ### [`v4.18.3`](https://github.com/python-jsonschema/jsonschema/blob/HEAD/CHANGELOG.rst#v4183) [Compare Source](https://github.com/python-jsonschema/jsonschema/compare/v4.18.2...v4.18.3) \======= - Properly preserve `applicable_validators` in extended validators. Specifically, validators extending early drafts where siblings of `$ref` were ignored will properly ignore siblings in the extended validator. ### [`v4.18.2`](https://github.com/python-jsonschema/jsonschema/blob/HEAD/CHANGELOG.rst#v4182) [Compare Source](https://github.com/python-jsonschema/jsonschema/compare/v4.18.1...v4.18.2) \======= - Fix an additional regression with the deprecated `jsonschema.RefResolver` and pointer resolution. ### [`v4.18.1`](https://github.com/python-jsonschema/jsonschema/blob/HEAD/CHANGELOG.rst#v4181) [Compare Source](https://github.com/python-jsonschema/jsonschema/compare/v4.18.0...v4.18.1) \======= - Fix a regression with `jsonschema.RefResolver` based resolution when used in combination with a custom validation dialect (via `jsonschema.validators.create`). ### [`v4.18.0`](https://github.com/python-jsonschema/jsonschema/blob/HEAD/CHANGELOG.rst#v4180) [Compare Source](https://github.com/python-jsonschema/jsonschema/compare/v4.17.3...v4.18.0) \======= This release majorly rehauls the way in which JSON Schema reference resolution is configured. It does so in a way that *should* be backwards compatible, preserving old behavior whilst emitting deprecation warnings. - `jsonschema.RefResolver` is now deprecated in favor of the new `referencing library <https://github.com/python-jsonschema/referencing/>`\_. `referencing` will begin in beta, but already is more compliant than the existing `$ref` support. This change is a culmination of a meaningful chunk of work to make `$ref` resolution more flexible and more correct. Backwards compatibility *should* be preserved for existing code which uses `RefResolver`, though doing so is again now deprecated, and all such use cases should be doable using the new APIs. Please file issues on the `referencing` tracker if there is functionality missing from it, or here on the `jsonschema` issue tracker if you have issues with existing code not functioning the same, or with figuring out how to change it to use `referencing`. In particular, this referencing change includes a change concerning *automatic* retrieval of remote references (retrieving `http://foo/bar` automatically within a schema). This behavior has always been a potential security risk and counter to the recommendations of the JSON Schema specifications; it has survived this long essentially only for backwards compatibility reasons, and now explicitly produces warnings. The `referencing` library itself will *not* automatically retrieve references if you interact directly with it, so the deprecated behavior is only triggered if you fully rely on the default `$ref` resolution behavior and also include remote references in your schema, which will still be retrieved during the deprecation period (after which they will become an error). - Support for Python 3.7 has been dropped, as it is nearing end-of-life. This should not be a "visible" change in the sense that `requires-python` has been updated, so users using 3.7 should still receive `v4.17.3` when installing the library. - On draft 2019-09, `unevaluatedItems` now properly does *not* consider items to be evaluated by an `additionalItems` schema if `items` is missing from the schema, as the specification says in this case that `additionalItems` must be completely ignored. - Fix the `date` format checker on Python 3.11 (when format assertion behavior is enabled), where it was too liberal ([#1076](https://github.com/python-jsonschema/jsonschema/issues/1076)). - Speed up validation of `unevaluatedProperties` ([#1075](https://github.com/python-jsonschema/jsonschema/issues/1075)). ## Deprecations - `jsonschema.RefResolver` -- see above for details on the replacement - `jsonschema.RefResolutionError` -- see above for details on the replacement - relying on automatic resolution of remote references -- see above for details on the replacement - importing `jsonschema.ErrorTree` -- instead import it via `jsonschema.exceptions.ErrorTree` - importing `jsonschema.FormatError` -- instead import it via `jsonschema.exceptions.FormatError` </details> <details> <summary>mkdocs/mkdocs (mkdocs)</summary> ### [`v1.6.1`](https://github.com/mkdocs/mkdocs/releases/tag/1.6.1) [Compare Source](https://github.com/mkdocs/mkdocs/compare/1.6.0...1.6.1) ##### Version 1.6.1 (Friday 30th August, 2024) ##### Fixed - Fix build error when environment variable `SOURCE_DATE_EPOCH=0` is set. [#3795](https://github.com/mkdocs/mkdocs/issues/3795) - Fix build error when `mkdocs_theme.yml` config is empty. [#3700](https://github.com/mkdocs/mkdocs/issues/3700) - Support `python -W` and `PYTHONWARNINGS` instead of overriding the configuration. [#3809](https://github.com/mkdocs/mkdocs/issues/3809) - Support running with Docker under strict mode, by removing `0.0.0.0` dev server warning. [#3784](https://github.com/mkdocs/mkdocs/issues/3784) - Drop unnecessary `changefreq` from `sitemap.xml`. [#3629](https://github.com/mkdocs/mkdocs/issues/3629) - Fix JavaScript console error when closing menu dropdown. [#3774](https://github.com/mkdocs/mkdocs/issues/3774) - Fix JavaScript console error that occur on repeated clicks. [#3730](https://github.com/mkdocs/mkdocs/issues/3730) - Fix JavaScript console error that can occur on dropdown selections. [#3694](https://github.com/mkdocs/mkdocs/issues/3694) ##### Added - Added translations for Dutch. [#3804](https://github.com/mkdocs/mkdocs/issues/3804) - Added and updated translations for Chinese (Simplified). [#3684](https://github.com/mkdocs/mkdocs/issues/3684) ### [`v1.6.0`](https://github.com/mkdocs/mkdocs/releases/tag/1.6.0) [Compare Source](https://github.com/mkdocs/mkdocs/compare/1.5.3...1.6.0) ##### Local preview - `mkdocs serve` no longer locks up the browser when more than 5 tabs are open. This is achieved by closing the polling connection whenever a tab becomes inactive. Background tabs will no longer auto-reload either - that will instead happen as soon the tab is opened again. Context: [#3391](https://github.com/mkdocs/mkdocs/issues/3391) - New flag `serve --open` to open the site in a browser.\ After the first build is finished, this flag will cause the default OS Web browser to be opened at the home page of the local site.\ Context: [#3500](https://github.com/mkdocs/mkdocs/issues/3500) ##### Drafts > \[!warning] > **Changed from version 1.5:** > > **The `exclude_docs` config was split up into two separate concepts.** The `exclude_docs` config no longer has any special behavior for `mkdocs serve` - it now always completely excludes the listed documents from the site. If you wish to use the "drafts" functionality like the `exclude_docs` key used to do in MkDocs 1.5, please switch to the **new config key `draft_docs`**. See [documentation](https://www.mkdocs.org/user-guide/configuration/#exclude_docs). Other changes: - Reduce warning levels when a "draft" page has a link to a non-existent file. Context: [#3449](https://github.com/mkdocs/mkdocs/issues/3449) ##### Update to deduction of page titles MkDocs 1.5 had a change in behavior in deducing the page titles from the first heading. Unfortunately this could cause unescaped HTML tags or entities to appear in edge cases. Now tags are always fully sanitized from the title. Though it still remains the case that [`Page.title`](https://www.mkdocs.org/dev-guide/api/#mkdocs.structure.files.pages.Page.title) is expected to contain HTML entities and is passed directly to the themes. Images (notably, emojis in some extensions) get preserved in the title only through their `alt` attribute's value. Context: [#3564](https://github.com/mkdocs/mkdocs/issues/3564), [#3578](https://github.com/mkdocs/mkdocs/issues/3578) ##### Themes - Built-in themes now also support Polish language ([#3613](https://github.com/mkdocs/mkdocs/issues/3613)) ##### "readthedocs" theme - Fix: "readthedocs" theme can now correctly handle deeply nested nav configurations (over 2 levels deep), without confusedly expanding all sections and jumping around vertically. ([#3464](https://github.com/mkdocs/mkdocs/issues/3464)) - Fix: "readthedocs" theme now shows a link to the repository (with a generic logo) even when isn't one of the 3 known hosters. ([#3435](https://github.com/mkdocs/mkdocs/issues/3435)) - "readthedocs" theme now also has translation for the word "theme" in the footer that mistakenly always remained in English. ([#3613](https://github.com/mkdocs/mkdocs/issues/3613), [#3625](https://github.com/mkdocs/mkdocs/issues/3625)) ##### "mkdocs" theme The "mkdocs" theme got a big update to a newer version of Bootstrap, meaning a slight overhaul of styles. Colors (most notably of admonitions) have much better contrast. The "mkdocs" theme now has support for dark mode - both automatic (based on the OS/browser setting) and with a manual toggle. Both of these options are **not** enabled by default and need to be configured explicitly.\ See `color_mode`, `user_color_mode_toggle` in [**documentation**](https://www.mkdocs.org/user-guide/choosing-your-theme/#mkdocs). > \[!warning] > **Possible breaking change:** > > jQuery is no longer included into the "mkdocs" theme. If you were relying on it in your scripts, you will need to separately add it first (into mkdocs.yml) as an extra script: > > ```yaml > extra_javascript: > - https://code.jquery.com/jquery-3.7.1.min.js > ``` > > Or even better if the script file is copied and included from your docs dir. Context: [#3493](https://github.com/mkdocs/mkdocs/issues/3493), [#3649](https://github.com/mkdocs/mkdocs/issues/3649) ##### Configuration ##### New "`enabled`" setting for all plugins You may have seen some plugins take up the convention of having a setting `enabled: false` (or usually controlled through an environment variable) to make the plugin do nothing. Now *every* plugin has this setting. Plugins can still *choose* to implement this config themselves and decide how it behaves (and unless they drop older versions of MkDocs, they still should for now), but now there's always a fallback for every plugin. See [**documentation**](https://www.mkdocs.org/user-guide/configuration/#enabled-option). Context: [#3395](https://github.com/mkdocs/mkdocs/issues/3395) ##### Validation ##### Validation of hyperlinks between pages ##### Absolute links > Historically, within Markdown, MkDocs only recognized **relative** links that lead to another physical `*.md` document (or media file). This is a good convention to follow because then the source pages are also freely browsable without MkDocs, for example on GitHub. Whereas absolute links were left unmodified (making them often not work as expected or, more recently, warned against). If you dislike having to always use relative links, now you can opt into absolute links and have them work correctly. If you set the setting `validation.links.absolute_links` to the new value `relative_to_docs`, all Markdown links starting with `/` will be understood as being relative to the `docs_dir` root. The links will then be validated for correctness according to all the other rules that were already working for relative links in prior versions of MkDocs. For the HTML output, these links will still be turned relative so that the site still works reliably. So, now any document (e.g. "dir1/foo.md") can link to the document "dir2/bar.md" as `[link](/dir2/bar.md)`, in addition to the previously only correct way `[link](../dir2/bar.md)`. You have to enable the setting, though. The default is still to just skip any processing of such links. See [**documentation**](https://www.mkdocs.org/user-guide/configuration/#validation-of-absolute-links). Context: [#3485](https://github.com/mkdocs/mkdocs/issues/3485) ##### Absolute links within nav Absolute links within the `nav:` config were also always skipped. It is now possible to also validate them in the same way with `validation.nav.absolute_links`. Though it makes a bit less sense because then the syntax is simply redundant with the syntax that comes without the leading slash. ##### Anchors There is a new config setting that is recommended to enable warnings for: ```yaml validation: anchors: warn ``` Example of a warning that this can produce: ```text WARNING - Doc file 'foo/example.md' contains a link '../bar.md#some-heading', but the doc 'foo/bar.md' does not contain an anchor '#some-heading'. ``` Any of the below methods of declaring an anchor will be detected by MkDocs: ```markdown ##### Heading producing an anchor ##### Another heading {#custom-anchor-for-heading-using-attr-list} <a id="raw-anchor"></a> [](){#markdown-anchor-using-attr-list} ``` Plugins and extensions that insert anchors, in order to be compatible with this, need to be developed as treeprocessors that insert `etree` elements as their mode of operation, rather than raw HTML which is undetectable for this purpose. If you as a user are dealing with falsely reported missing anchors and there's no way to resolve this, you can choose to disable these messages by setting this option to `ignore` (and they are at INFO level by default anyway). See [**documentation**](https://www.mkdocs.org/user-guide/configuration/#validation). Context: [#3463](https://github.com/mkdocs/mkdocs/issues/3463) Other changes: - When the `nav` config is not specified at all, the `not_in_nav` setting (originally added in 1.5.0) gains an additional behavior: documents covered by `not_in_nav` will not be part of the automatically deduced navigation. Context: [#3443](https://github.com/mkdocs/mkdocs/issues/3443) - Fix: the `!relative` YAML tag for `markdown_extensions` (originally added in 1.5.0) - it was broken in many typical use cases. See [**documentation**](https://www.mkdocs.org/user-guide/configuration/#paths-relative-to-the-current-file-or-site). Context: [#3466](https://github.com/mkdocs/mkdocs/issues/3466) - Config validation now exits on first error, to avoid showing bizarre secondary errors. Context: [#3437](https://github.com/mkdocs/mkdocs/issues/3437) - MkDocs used to shorten error messages for unexpected errors such as "file not found", but that is no longer the case, the full error message and stack trace will be possible to see (unless the error has a proper handler, of course). Context: [#3445](https://github.com/mkdocs/mkdocs/issues/3445) ##### Upgrades for plugin developers ##### Plugins can add multiple handlers for the same event type, at multiple priorities See [`mkdocs.plugins.CombinedEvent`](https://www.mkdocs.org/dev-guide/plugins/#mkdocs.plugins.CombinedEvent) in [**documentation**](https://www.mkdocs.org/dev-guide/plugins/#event-priorities). Context: [#3448](https://github.com/mkdocs/mkdocs/issues/3448) ##### Enabling true generated files and expanding the [`File`](https://www.mkdocs.org/dev-guide/api/#mkdocs.structure.files.File) API See [**documentation**](https://www.mkdocs.org/dev-guide/api/#mkdocs.structure.files.File). - There is a new pair of attributes [`File.content_string`](https://www.mkdocs.org/dev-guide/api/#mkdocs.structure.files.File.content_string]/\[\`content_bytes\`]\[mkdocs.structure.files.File.content_bytes) that becomes the official API for obtaining the content of a file and is used by MkDocs itself. This replaces the old approach where one had to manually read the file located at [`File.abs_src_path`](https://www.mkdocs.org/dev-guide/api/#mkdocs.structure.files.File.abs_src_path), although that is still the primary action that these new attributes do under the hood. - The content of a `File` can be backed by a string and no longer has to be a real existing file at `abs_src_path`. It is possible to **set** the attribute `File.content_string` or `File.content_bytes` and it will take precedence over `abs_src_path`. Further, `abs_src_path` is no longer guaranteed to be present and can be `None` instead. MkDocs itself still uses physical files in all cases, but eventually plugins will appear that don't populate this attribute. - There is a new constructor [`File.generated()`](https://www.mkdocs.org/dev-guide/api/#mkdocs.structure.files.File.generated) that should be used by plugins instead of the `File()` constructor. It is much more convenient because one doesn't need to manually look up the values such as `docs_dir` and `use_directory_urls`. Its signature is one of: ```python f = File.generated(config: MkDocsConfig, src_uri: str, content: str | bytes) f = File.generated(config: MkDocsConfig, src_uri: str, abs_src_path: str) ``` This way, it is now extremely easy to add a virtual file even from a hook: ```python def on_files(files: Files, config: MkDocsConfig): files.append(File.generated(config, 'fake/path.md', content="Hello, world!")) ``` For large content it is still best to use physical files, but one no longer needs to manipulate the path by providing a fake unused `docs_dir`. - There is a new attribute [`File.generated_by`](https://www.mkdocs.org/dev-guide/api/#mkdocs.structure.files.File.generated_by) that arose by convention - for generated files it should be set to the name of the plugin (the key in the `plugins:` collection) that produced this file. This attribute is populated automatically when using the `File.generated()` constructor. - It is possible to set the [`edit_uri`](https://www.mkdocs.org/dev-guide/api/#mkdocs.structure.files.File.edit_uri) attribute of a `File`, for example from a plugin or hook, to make it different from the default (equal to `src_uri`), and this will be reflected in the edit link of the document. This can be useful because some pages aren't backed by a real file and are instead created dynamically from some other source file or script. So a hook could set the `edit_uri` to that source file or script accordingly. - The `File` object now stores its original `src_dir`, `dest_dir`, `use_directory_urls` values as attributes. - Fields of `File` are computed on demand but cached. Only the three above attributes are primary ones, and partly also [`dest_uri`](https://www.mkdocs.org/dev-guide/api/#mkdocs.structure.files.File.dest_uri). This way, it is possible to, for example, overwrite `dest_uri` of a `File`, and `abs_dest_path` will be calculated based on it. However you need to clear the attribute first using `del f.abs_dest_path`, because the values are cached. - `File` instances are now hashable (can be used as keys of a `dict`). Two files can no longer be considered "equal" unless it's the exact same instance of `File`. Other changes: - The internal storage of `File` objects inside a `Files` object has been reworked, so any plugins that choose to access `Files._files` will get a deprecation warning. - The order of `File` objects inside a `Files` collection is no longer significant when automatically inferring the `nav`. They get forcibly sorted according to the default alphabetic order. Context: [#3451](https://github.com/mkdocs/mkdocs/issues/3451), [#3463](https://github.com/mkdocs/mkdocs/issues/3463) ##### Hooks and debugging - Hook files can now import adjacent \*.py files using the `import` statement. Previously this was possible to achieve only through a `sys.path` workaround. See the new mention in [documentation](https://www.mkdocs.org/user-guide/configuration/#hooks). Context: [#3568](https://github.com/mkdocs/mkdocs/issues/3568) - Verbose `-v` log shows the sequence of plugin events in more detail - shows each invoked plugin one by one, not only the event type. Context: [#3444](https://github.com/mkdocs/mkdocs/issues/3444) ##### Deprecations - Python 3.7 is no longer supported, Python 3.12 is officially supported. Context: [#3429](https://github.com/mkdocs/mkdocs/issues/3429) - The theme config file `mkdocs_theme.yml` no longer executes YAML tags. Context: [#3465](https://github.com/mkdocs/mkdocs/issues/3465) - The plugin event `on_page_read_source` is soft-deprecated because there is always a better alternative to it (see the new `File` API or just `on_page_markdown`, depending on the desired interaction). When multiple plugins/hooks apply this event handler, they trample over each other, so now there is a warning in that case. See [**documentation**](https://www.mkdocs.org/dev-guide/plugins/#on_page_read_source). Context: [#3503](https://github.com/mkdocs/mkdocs/issues/3503) ##### API deprecations - It is no longer allowed to set `File.page` to a type other than `Page` or a subclass thereof. Context: [#3443](https://github.com/mkdocs/mkdocs/issues/3443) - following the deprecation in version 1.5.3 and [#3381](https://github.com/mkdocs/mkdocs/issues/3381). - `Theme._vars` is deprecated - use `theme['foo']` instead of `theme._vars['foo']` - `utils`: `modified_time()`, `get_html_path()`, `get_url_path()`, `is_html_file()`, `is_template_file()` are removed. `path_to_url()` is deprecated. - `LiveReloadServer.watch()` no longer accepts a custom callback. Context: [#3429](https://github.com/mkdocs/mkdocs/issues/3429) ##### Misc - The `sitemap.xml.gz` file is slightly more reproducible and no longer changes on every build, but instead only once per day (upon a date change). Context: [#3460](https://github.com/mkdocs/mkdocs/issues/3460) Other small improvements; see [commit log](https://github.com/mkdocs/mkdocs/compare/1.5.3...1.6.0). </details> <details> <summary>squidfunk/mkdocs-material (mkdocs-material)</summary> ### [`v9.6.10`](https://github.com/squidfunk/mkdocs-material/releases/tag/9.6.10): mkdocs-material-9.6.10 [Compare Source](https://github.com/squidfunk/mkdocs-material/compare/9.6.9...9.6.10) This version is a pure refactoring release, and does not contain new features or bug fixes. It strives to improve the compatibility of our templates with alternative Jinja-like template engines that we're currently exploring, including [minijinja]. Additionally, it replaces several instances of Python function invocations with idiomatic use of template filters. All instances where variables have been mutated inside templates have been replaced. Most changes have been made in partials, and only a few in blocks, and all of them are fully backward compatible, so no changes to overrides are necessary. Note that this release does not replace the Jinja template engine with minijinja. However, our templates are now 99% compatible with minijinja, which means we can explore alternative Jinja-compatible implementations. Additionally, immutability and removal of almost all Python function invocations means much more idiomatic templating. [minijinja]: https://github.com/mitsuhiko/minijinja ### [`v9.6.9`](https://github.com/squidfunk/mkdocs-material/releases/tag/9.6.9): mkdocs-material-9.6.9 [Compare Source](https://github.com/squidfunk/mkdocs-material/compare/9.6.8...9.6.9) - Updated Serbo-Croatian translations - Fixed [#8086](https://github.com/squidfunk/mkdocs-material/issues/8086): Custom SVG icons containing hashes break rendering - Fixed [#8067](https://github.com/squidfunk/mkdocs-material/issues/8067): Drawer has gap on right side in Firefox on some OSs ### [`v9.6.8`](https://github.com/squidfunk/mkdocs-material/releases/tag/9.6.8): mkdocs-material-9.6.8 [Compare Source](https://github.com/squidfunk/mkdocs-material/compare/9.6.7...9.6.8) - Added Welsh translations - Fixed [#8076](https://github.com/squidfunk/mkdocs-material/issues/8076): Privacy plugin crashes if HTTP download fails ### [`v9.6.7`](https://github.com/squidfunk/mkdocs-material/releases/tag/9.6.7): mkdocs-material-9.6.7 [Compare Source](https://github.com/squidfunk/mkdocs-material/compare/9.6.6...9.6.7) - Fixed [#8056](https://github.com/squidfunk/mkdocs-material/issues/8056): Error in backrefs implementation (9.6.6 regression) - Fixed [#8054](https://github.com/squidfunk/mkdocs-material/issues/8054): Unescaped quotes in ARIA labels of table of contents ### [`v9.6.6`](https://github.com/squidfunk/mkdocs-material/releases/tag/9.6.6): mkdocs-material-9.6.6 [Compare Source](https://github.com/squidfunk/mkdocs-material/compare/9.6.5...9.6.6) - Fixed [#8040](https://github.com/squidfunk/mkdocs-material/issues/8040): Privacy plugin not replacing exteral assets (9.6.5 regression) - Fixed [#8031](https://github.com/squidfunk/mkdocs-material/issues/8031): Replace unmaintained `regex` package in search plugin ### [`v9.6.5`](https://github.com/squidfunk/mkdocs-material/releases/tag/9.6.5): mkdocs-material-9.6.5 [Compare Source](https://github.com/squidfunk/mkdocs-material/compare/9.6.4...9.6.5) - Fixed [#8016](https://github.com/squidfunk/mkdocs-material/issues/8016): Tags listing not showing when when file name has spaces - Fixed [#8012](https://github.com/squidfunk/mkdocs-material/issues/8012): Privacy plugin crashes if HTTP download fails ### [`v9.6.4`](https://github.com/squidfunk/mkdocs-material/releases/tag/9.6.4): mkdocs-material-9.6.4 [Compare Source](https://github.com/squidfunk/mkdocs-material/compare/9.6.3...9.6.4) - Fixed [#7985](https://github.com/squidfunk/mkdocs-material/issues/7985): Blog content sometimes not stretching to full width - Fixed [#7978](https://github.com/squidfunk/mkdocs-material/issues/7978): Navigation rendering bug in Safari 18.3 ### [`v9.6.3`](https://github.com/squidfunk/mkdocs-material/releases/tag/9.6.3): mkdocs-material-9.6.3 [Compare Source](https://github.com/squidfunk/mkdocs-material/compare/9.6.2...9.6.3) - Fixed rendering of arrow heads in Mermaid.js class diagrams - Fixed [#7960](https://github.com/squidfunk/mkdocs-material/issues/7960): Tags plugin crashes on numeric metadata titles ### [`v9.6.2`](https://github.com/squidfunk/mkdocs-material/releases/tag/9.6.2): mkdocs-material-9.6.2 [Compare Source](https://github.com/squidfunk/mkdocs-material/compare/9.6.1...9.6.2) - Fixed [#7955](https://github.com/squidfunk/mkdocs-material/issues/7955): Excessively long words don't break on narrow screens - Fixed [#7947](https://github.com/squidfunk/mkdocs-material/issues/7947): Scope setting interferes with outdated version banner ### [`v9.6.1`](https://github.com/squidfunk/mkdocs-material/releases/tag/9.6.1): mkdocs-material-9.6.1 [Compare Source](https://github.com/squidfunk/mkdocs-material/compare/9.6.0...9.6.1) - Fixed [#7943](https://github.com/squidfunk/mkdocs-material/issues/7943): Tags plugin crashing due to merge error ### [`v9.6.0`](https://github.com/squidfunk/mkdocs-material/releases/tag/9.6.0): mkdocs-material-9.6.0 [Compare Source](https://github.com/squidfunk/mkdocs-material/compare/9.5.50...9.6.0) - Added meta plugin - Rewrite of the tags plugin - Added support for allow lists in tags plugin - Added support for and custom sorting in tags plugin - Added support for related links in blog plugin - Added support for custom index pages in blog plugin - Added support for navigation subtitles - Fixed [#7924](https://github.com/squidfunk/mkdocs-material/issues/7924): Anchors might require two clicks when using instant navigation ### [`v9.5.50`](https://github.com/squidfunk/mkdocs-material/releases/tag/9.5.50): mkdocs-material-9.5.50 [Compare Source](https://github.com/squidfunk/mkdocs-material/compare/9.5.49...9.5.50) - Fixed [#7913](https://github.com/squidfunk/mkdocs-material/issues/7913): Social plugin renders attribute lists in page title ### [`v9.5.49`](https://github.com/squidfunk/mkdocs-material/releases/tag/9.5.49): mkdocs-material-9.5.49 [Compare Source](https://github.com/squidfunk/mkdocs-material/compare/9.5.48...9.5.49) - Adjusted title color in dark mode for all supported Mermaid.js diagrams - Fixed [#7803](https://github.com/squidfunk/mkdocs-material/issues/7803): Privacy plugin crashes on generated files - Fixed [#7781](https://github.com/squidfunk/mkdocs-material/issues/7781): Mermaid.js flow chart title not visible in dark mode ### [`v9.5.48`](https://github.com/squidfunk/mkdocs-material/releases/tag/9.5.48): mkdocs-material-9.5.48 [Compare Source](https://github.com/squidfunk/mkdocs-material/compare/9.5.47...9.5.48) - Fixed [#7774](https://github.com/squidfunk/mkdocs-material/issues/7774): Disabling social cards doesn't work ### [`v9.5.47`](https://github.com/squidfunk/mkdocs-material/releases/tag/9.5.47): mkdocs-material-9.5.47 [Compare Source](https://github.com/squidfunk/mkdocs-material/compare/9.5.46...9.5.47) - Fixed [#7750](https://github.com/squidfunk/mkdocs-material/issues/7750): Numeric tags break search - Fixed [#7748](https://github.com/squidfunk/mkdocs-material/issues/7748): Blog plugin breaks when using future drafts (9.5.45 regression) Thanks go to [@perpil](https://github.com/perpil) for their contributions ### [`v9.5.46`](https://github.com/squidfunk/mkdocs-material/releases/tag/9.5.46): mkdocs-material-9.5.46 [Compare Source](https://github.com/squidfunk/mkdocs-material/compare/9.5.45...9.5.46) - Added support for removing `preload` hints in privacy plugin - Fixed [#7734](https://github.com/squidfunk/mkdocs-material/issues/7734): Code blocks in h5 headlines are uppercased - Fixed [#7725](https://github.com/squidfunk/mkdocs-material/issues/7725): Blog plugin crashing on missing timezone (9.5.45 regression) Thanks go to [@nejch](https://github.com/nejch) and [@perpil](https://github.com/perpil) for their contributions ### [`v9.5.45`](https://github.com/squidfunk/mkdocs-material/releases/tag/9.5.45): mkdocs-material-9.5.45 [Compare Source](https://github.com/squidfunk/mkdocs-material/compare/9.5.44...9.5.45) - Reduced size of Docker image through multi-stage build - Fixed [#7708](https://github.com/squidfunk/mkdocs-material/issues/7708): Blog plugin crashing on YAML dates with timezones Thanks go to [@FrancoisCapon](https://github.com/FrancoisCapon) and [@perpil](https://github.com/perpil) for their contributions ### [`v9.5.44`](https://github.com/squidfunk/mkdocs-material/releases/tag/9.5.44): mkdocs-material-9.5.44 [Compare Source](https://github.com/squidfunk/mkdocs-material/compare/9.5.43...9.5.44) - Fixed [#7672](https://github.com/squidfunk/mkdocs-material/issues/7672): Font CSS 404's when using privacy plugin (9.5.43 regression) Thanks go to [@nejch](https://github.com/nejch) for their contributions. ### [`v9.5.43`](https://github.com/squidfunk/mkdocs-material/releases/tag/9.5.43): mkdocs-material-9.5.43 [Compare Source](https://github.com/squidfunk/mkdocs-material/compare/9.5.42...9.5.43) - Added support for external images in SVGs in privacy plugin - Fixed [#7651](https://github.com/squidfunk/mkdocs-material/issues/7651): Privacy plugin doesn't handle quoted URLs in CSS Thanks go to [@nejch](https://github.com/nejch) for their contributions ### [`v9.5.42`](https://github.com/squidfunk/mkdocs-material/releases/tag/9.5.42): mkdocs-material-9.5.42 [Compare Source](https://github.com/squidfunk/mkdocs-material/compare/9.5.41...9.5.42) - Fixed [#7625](https://github.com/squidfunk/mkdocs-material/issues/7625): Invalid encoding of boolean attributes in privacy plugin - Fixed [#7624](https://github.com/squidfunk/mkdocs-material/issues/7624): Crash when disabling privacy plugin (9.5.41 regression) ### [`v9.5.41`](https://github.com/squidfunk/mkdocs-material/releases/tag/9.5.41): mkdocs-material-9.5.41 [Compare Source](https://github.com/squidfunk/mkdocs-material/compare/9.5.40...9.5.41) - Fixed [#7619](https://github.com/squidfunk/mkdocs-material/issues/7619): Improved tooltip on logo disappears after instant navigation - Fixed [#7616](https://github.com/squidfunk/mkdocs-material/issues/7616): Race condition in built-in privacy plugin when inlining assets - Fixed [#7615](https://github.com/squidfunk/mkdocs-material/issues/7615): Comments and "Was this page helpful?" visible when printing ### [`v9.5.40`](https://github.com/squidfunk/mkdocs-material/releases/tag/9.5.40): mkdocs-material-9.5.40 [Compare Source](https://github.com/squidfunk/mkdocs-material/compare/9.5.39...9.5.40) - Updated Latvian translations - Fixed [#7597](https://github.com/squidfunk/mkdocs-material/issues/7597): Social cards not using site name on home page Thanks go to [@pekkaklarck](https://github.com/pekkaklarck) and [@klejejs](https://github.com/klejejs) for their contributions ### [`v9.5.39`](https://github.com/squidfunk/mkdocs-material/releases/tag/9.5.39): mkdocs-material-9.5.39 [Compare Source](https://github.com/squidfunk/mkdocs-material/compare/9.5.38...9.5.39) - Fixed [#7226](https://github.com/squidfunk/mkdocs-material/issues/7226): not staying on page when using mike's canonical versioning Thanks go to [@ilyagr](https://github.com/ilyagr) for their contributions ### [`v9.5.38`](https://github.com/squidfunk/mkdocs-material/releases/tag/9.5.38): mkdocs-material-9.5.38 [Compare Source](https://github.com/squidfunk/mkdocs-material/compare/9.5.37...9.5.38) - Added Albanian translations Thanks go to [@gerardkraja](https://github.com/gerardkraja) for their contributions ### [`v9.5.37`](https://github.com/squidfunk/mkdocs-material/releases/tag/9.5.37): mkdocs-material-9.5.37 [Compare Source](https://github.com/squidfunk/mkdocs-material/compare/9.5.36...9.5.37) - Added 4th and 5th level ordered list styles - Fixed [#7548](https://github.com/squidfunk/mkdocs-material/issues/7548): Tags have no spacing in search ### [`v9.5.36`](https://github.com/squidfunk/mkdocs-material/releases/tag/9.5.36): mkdocs-material-9.5.36 [Compare Source](https://github.com/squidfunk/mkdocs-material/compare/9.5.35...9.5.36) - Fixed [#7544](https://github.com/squidfunk/mkdocs-material/issues/7544): Social cards incorrectly rendering HTML entities - Fixed [#7542](https://github.com/squidfunk/mkdocs-material/issues/7542): Improved support for setting custom list styles ### [`v9.5.35`](https://github.com/squidfunk/mkdocs-material/releases/tag/9.5.35): mkdocs-material-9.5.35 [Compare Source](https://github.com/squidfunk/mkdocs-material/compare/9.5.34...9.5.35) - Fixed [#7498](https://github.com/squidfunk/mkdocs-material/issues/7498): Search not showing for Vietnamese language ### [`v9.5.34`](https://github.com/squidfunk/mkdocs-material/releases/tag/9.5.34): mkdocs-material-9.5.34 [Compare Source](https://github.com/squidfunk/mkdocs-material/compare/9.5.33...9.5.34) - Updated Mermaid.js to version 11 (latest) Thanks go to [@manselmi](https://github.com/manselmi) for their contributions ### [`v9.5.33`](https://github.com/squidfunk/mkdocs-material/releases/tag/9.5.33): mkdocs-material-9.5.33 [Compare Source](https://github.com/squidfunk/mkdocs-material/compare/9.5.32...9.5.33) - Fixed [#7453](https://github.com/squidfunk/mkdocs-material/issues/7453): Incorrect position of tooltip when sorting table ### [`v9.5.32`](https://github.com/squidfunk/mkdocs-material/releases/tag/9.5.32): mkdocs-material-9.5.32 [Compare Source](https://github.com/squidfunk/mkdocs-material/compare/9.5.31...9.5.32) - Fixed RXSS vulnerability via deep link in search results - Added support for fetching latest release from GitLab Thanks go to [@joaopalmeiro](https://github.com/joaopalmeiro) for their contributions ### [`v9.5.31`](https://github.com/squidfunk/mkdocs-material/releases/tag/9.5.31): mkdocs-material-9.5.31 [Compare Source](https://github.com/squidfunk/mkdocs-material/compare/9.5.30...9.5.31) - Fixed [#7405](https://github.com/squidfunk/mkdocs-material/issues/7405): DockerHub missing images > 9.5.27 due to change in Alpine/APK ### [`v9.5.30`](https://github.com/squidfunk/mkdocs-material/releases/tag/9.5.30): mkdocs-material-9.5.30 [Compare Source](https://github.com/squidfunk/mkdocs-material/compare/9.5.29...9.5.30) - Fixed [#7380](https://github.com/squidfunk/mkdocs-material/issues/7380): Navigation icons disappearing on hover in Safari - Fixed [#7367](https://github.com/squidfunk/mkdocs-material/issues/7367): Blog readtime computation includes SVG text content Thanks go to [@sisp](https://github.com/sisp) for their contributions ### [`v9.5.29`](https://github.com/squidfunk/mkdocs-material/releases/tag/9.5.29): mkdocs-material-9.5.29 [Compare Source](https://github.com/squidfunk/mkdocs-material/compare/9.5.28...9.5.29) - Updated Galician translations - Fixed [#7362](https://github.com/squidfunk/mkdocs-material/issues/7362): Annotations in figure captions rendering incorrectly Thanks go to [@mmontes11](https://github.com/mmontes11) for their contributions ### [`v9.5.28`](https://github.com/squidfunk/mkdocs-material/releases/tag/9.5.28): mkdocs-material-9.5.28 [Compare Source](https://github.com/squidfunk/mkdocs-material/compare/9.5.27...9.5.28) - Fixed [#7313](https://github.com/squidfunk/mkdocs-material/issues/7313): Improved tooltips mounted in sidebar when feature is disabled ### [`v9.5.27`](https://github.com/squidfunk/mkdocs-material/releases/tag/9.5.27): mkdocs-material-9.5.27 [Compare Source](https://github.com/squidfunk/mkdocs-material/compare/9.5.26...9.5.27) - Updated Estonian translations Thanks to [@Eilyre](https://github.com/Eilyre) for their contributions ### [`v9.5.26`](https://github.com/squidfunk/mkdocs-material/releases/tag/9.5.26): mkdocs-material-9.5.26 [Compare Source](https://github.com/squidfunk/mkdocs-material/compare/9.5.25...9.5.26) - Fixed [#7232](https://github.com/squidfunk/mkdocs-material/issues/7232): Tab switches on scroll when linking tabs (9.5.19 regression) - Fixed [#7230](https://github.com/squidfunk/mkdocs-material/issues/7230): Blog author avatar broken when referring to local file ### [`v9.5.25`](https://github.com/squidfunk/mkdocs-material/releases/tag/9.5.25): mkdocs-material-9.5.25 [Compare Source](https://github.com/squidfunk/mkdocs-material/compare/9.5.24...9.5.25) - Fixed [#7209](https://github.com/squidfunk/mkdocs-material/issues/7209): Tags plugin crashing on numeric tags ### [`v9.5.24`](https://github.com/squidfunk/mkdocs-material/releases/tag/9.5.24): mkdocs-material-9.5.24 [Compare Source](https://github.com/squidfunk/mkdocs-material/compare/9.5.23...9.5.24) - Fixed [#7187](https://github.com/squidfunk/mkdocs-material/issues/7187): Version selector title rendering issue ### [`v9.5.23`](https://github.com/squidfunk/mkdocs-material/releases/tag/9.5.23): mkdocs-material-9.5.23 [Compare Source](https://github.com/squidfunk/mkdocs-material/compare/9.5.22...9.5.23) - Fixed [#7183](https://github.com/squidfunk/mkdocs-material/issues/7183): Edge case in anchor navigation when using instant navigation - Fixed [#6436](https://github.com/squidfunk/mkdocs-material/issues/6436): Version selector not showing version alias ### [`v9.5.22`](https://github.com/squidfunk/mkdocs-material/releases/tag/9.5.22): mkdocs-material-9.5.22 [Compare Source](https://github.com/squidfunk/mkdocs-material/compare/9.5.21...9.5.22) - Fixed [#7170](https://github.com/squidfunk/mkdocs-material/issues/7170): Copy button adds empty lines for line spans (9.5.18 regression) - Fixed [#7160](https://github.com/squidfunk/mkdocs-material/issues/7160): Version switching doesn't stay on page (9.5.5 regression) - Fixed [#5619](https://github.com/squidfunk/mkdocs-material/issues/5619): Links in Mermaid.js diagrams not discernible ### [`v9.5.21`](https://github.com/squidfunk/mkdocs-material/releases/tag/9.5.21): mkdocs-material-9.5.21 [Compare Source](https://github.com/squidfunk/mkdocs-material/compare/9.5.20...9.5.21) - Fixed [#7133](https://github.com/squidfunk/mkdocs-material/issues/7133): Ensure latest version of Mermaid.js is used - Fixed [#7125](https://github.com/squidfunk/mkdocs-material/issues/7125): Added warning for dotfiles in info plugin Thanks to [@kamilkrzyskow](https://github.com/kamilkrzyskow) for their contributions ### [`v9.5.20`](https://github.com/squidfunk/mkdocs-material/releases/tag/9.5.20): mkdocs-material-9.5.20 [Compare Source](https://github.com/squidfunk/mkdocs-material/compare/9.5.19...9.5.20) - Fixed deprecation warning in privacy plugin (9.5.19 regression) - Fixed [#7119](https://github.com/squidfunk/mkdocs-material/issues/7119): Tags plugin emits deprecation warning (9.5.19 regression) - Fixed [#7118](https://github.com/squidfunk/mkdocs-material/issues/7118): Social plugin crashes if fonts are disabled (9.5.19 regression) - Fixed [#7085](https://github.com/squidfunk/mkdocs-material/issues/7085): Social plugin crashes on Windows when downloading fonts ### [`v9.5.19`](https://github.com/squidfunk/mkdocs-material/releases/tag/9.5.19): mkdocs-material-9.5.19 [Compare Source](https://github.com/squidfunk/mkdocs-material/compare/9.5.18...9.5.19) - Updated MkDocs to 1.6 and limited version to < 2 - Updated Docker image to latest Alpine Linux - Removed `setup.py`, now that GitHub fully understands `pyproject.toml` - Improved interop of social plugin with third-party MkDocs themes - Fixed [#7099](https://github.com/squidfunk/mkdocs-material/issues/7099): Blog reading time not rendered correctly for Japanese - Fixed [#7097](https://github.com/squidfunk/mkdocs-material/issues/ </details> --- ### Configuration 📅 **Schedule**: Branch creation - "every 2 weeks on Sunday" (UTC), Automerge - At any time (no schedule defined). 🚦 **Automerge**: Disabled by config. Please merge this manually once you are satisfied. ♻ **Rebasing**: Whenever PR is behind base branch, or you tick the rebase/retry checkbox. 👻 **Immortal**: This PR will be recreated if closed unmerged. Get [config help](https://github.com/renovatebot/renovate/discussions) if that's undesired. --- - [ ] If you want to rebase/retry this PR, check this box --- This PR was generated by [Mend Renovate](https://mend.io/renovate/). View the [repository job log](https://developer.mend.io/github/splunk/addonfactory-ucc-generator).  Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>

**Issue number:** ADDON-78488 ### PR Type **What kind of change does this PR introduce?** * [x] Feature * [ ] Bug Fix * [ ] Refactoring (no functional or API changes) * [x] Documentation Update * [ ] Maintenance (dependency updates, CI, etc.) ## Summary ### Changes Going forward, if the globalConfig doesn't exist in the source directory of an add-on, the UCC framework would create one in the source directory and then proceed with processing of the build process. ### User experience Users using UCC framework for .conf-only TAs would now see a globalConfig.json created in their source code / source directory when they run the `ucc-gen build --source ...` command. ## Checklist If an item doesn't apply to your changes, leave it unchecked. ### Review * [x] self-review - I have performed a self-review of this change according to the [development guidelines](https://splunk.github.io/addonfactory-ucc-generator/contributing/#development-guidelines) * [x] Changes are documented. The documentation is understandable, examples work [(more info)](https://splunk.github.io/addonfactory-ucc-generator/contributing/#documentation-guidelines) * [x] PR title and description follows the [contributing principles](https://splunk.github.io/addonfactory-ucc-generator/contributing/#pull-requests) * [ ] meeting - I have scheduled a meeting or recorded a demo to explain these changes (if there is a video, put a link below and in the ticket) ### Tests See [the testing doc](https://splunk.github.io/addonfactory-ucc-generator/contributing/#build-and-test). * [x] Unit - tests have been added/modified to cover the changes * [x] Smoke - tests have been added/modified to cover the changes * [ ] UI - tests have been added/modified to cover the changes * [x] coverage - I have checked the code coverage of my changes [(see more)](https://splunk.github.io/addonfactory-ucc-generator/contributing/#checking-the-code-coverage) **Demo/meeting:** *Reviewers are encouraged to request meetings or demos if any part of the change is unclear* --------- Co-authored-by: srv-rr-github-token <[email protected]> Co-authored-by: Artem Rys <[email protected]>

**Issue number:** ### PR Type **What kind of change does this PR introduce?** * [ ] Feature * [ ] Bug Fix * [ ] Refactoring (no functional or API changes) * [ ] Documentation Update * [x] Maintenance (dependency updates, CI, etc.) ## Summary ### Changes Update UI deps except dashboards ones as in new version [issue](https://splunk.atlassian.net/browse/SCP-74840) is introduced. ### User experience N/A ## Checklist If an item doesn't apply to your changes, leave it unchecked. ### Review * [x] self-review - I have performed a self-review of this change according to the [development guidelines](https://splunk.github.io/addonfactory-ucc-generator/contributing/#development-guidelines) * [ ] Changes are documented. The documentation is understandable, examples work [(more info)](https://splunk.github.io/addonfactory-ucc-generator/contributing/#documentation-guidelines) * [x] PR title and description follows the [contributing principles](https://splunk.github.io/addonfactory-ucc-generator/contributing/#pull-requests) * [ ] meeting - I have scheduled a meeting or recorded a demo to explain these changes (if there is a video, put a link below and in the ticket) ### Tests See [the testing doc](https://splunk.github.io/addonfactory-ucc-generator/contributing/#build-and-test). * [ ] Unit - tests have been added/modified to cover the changes * [ ] Smoke - tests have been added/modified to cover the changes * [ ] UI - tests have been added/modified to cover the changes * [ ] coverage - I have checked the code coverage of my changes [(see more)](https://splunk.github.io/addonfactory-ucc-generator/contributing/#checking-the-code-coverage) **Demo/meeting:** *Reviewers are encouraged to request meetings or demos if any part of the change is unclear*

…1671) **Issue number:** ### PR Type **What kind of change does this PR introduce?** * [ ] Feature * [ ] Bug Fix * [x] Refactoring (no functional or API changes) * [ ] Documentation Update * [ ] Maintenance (dependency updates, CI, etc.) ## Summary ### Changes Due to the changes implemented in PR #1669, `globalConfig` is no longer optional. As a result, the `self.global_config` conditions are being removed from the generators. ### User experience No change in user experience. ## Checklist If an item doesn't apply to your changes, leave it unchecked. ### Review * [x] self-review - I have performed a self-review of this change according to the [development guidelines](https://splunk.github.io/addonfactory-ucc-generator/contributing/#development-guidelines) * [ ] Changes are documented. The documentation is understandable, examples work [(more info)](https://splunk.github.io/addonfactory-ucc-generator/contributing/#documentation-guidelines) * [x] PR title and description follows the [contributing principles](https://splunk.github.io/addonfactory-ucc-generator/contributing/#pull-requests) * [ ] meeting - I have scheduled a meeting or recorded a demo to explain these changes (if there is a video, put a link below and in the ticket) ### Tests See [the testing doc](https://splunk.github.io/addonfactory-ucc-generator/contributing/#build-and-test). * [x] Unit - tests have been added/modified to cover the changes * [ ] Smoke - tests have been added/modified to cover the changes * [ ] UI - tests have been added/modified to cover the changes * [x] coverage - I have checked the code coverage of my changes [(see more)](https://splunk.github.io/addonfactory-ucc-generator/contributing/#checking-the-code-coverage) **Demo/meeting:** *Reviewers are encouraged to request meetings or demos if any part of the change is unclear* --------- Co-authored-by: Artem Rys <[email protected]>

…command

hetangmodi-crest · 2025-04-01T11:05:38Z

Closing this PR due to GitHub issue - not able to show the updated changes present in the source and destination branch.

hetangmodi-crest · 2025-04-01T11:06:47Z

Created new PR with the same changes - PR #1672.

hetangmodi-crest added 2 commits March 21, 2025 17:07

docs: documentation for custom search command

3e1dbb4

feat: provide support for custom search command

68f0319

hetangmodi-crest added the enhancement New feature or request label Mar 21, 2025

hetangmodi-crest self-assigned this Mar 21, 2025

pull-request-size bot added the size/XXL label Mar 21, 2025

hetangmodi-crest mentioned this pull request Mar 21, 2025

test: add unit, smoke tests for custom search command #1654

Closed

13 tasks

hetangmodi-crest changed the title ~~feat: dev changes of custom search command~~ feat: add custom search command support Mar 21, 2025

hetangmodi-crest marked this pull request as ready for review March 21, 2025 15:05

hetangmodi-crest requested review from a team as code owners March 21, 2025 15:05

hetangmodi-crest requested review from kkedziak-splunk and vtsvetkov-splunk March 21, 2025 15:05

artemrys and others added 3 commits March 26, 2025 15:00

fix: updated handling of requiredSearchAssistant

af15e1b

artemrys and others added 6 commits March 28, 2025 15:47

chore: Merge branch 'develop' into feat/implementation-custom-search-…

b15c43a

…command

hetangmodi-crest requested a review from a team as a code owner April 1, 2025 10:47

hetangmodi-crest requested a review from rohanm-crest April 1, 2025 10:47

hetangmodi-crest closed this Apr 1, 2025

github-actions bot locked and limited conversation to collaborators Apr 1, 2025

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

feat: add custom search command support #1653

feat: add custom search command support #1653

Uh oh!

hetangmodi-crest commented Mar 21, 2025 •

edited

Loading

Uh oh!

kkedziak-splunk commented Mar 26, 2025

Uh oh!

hetangmodi-crest commented Mar 28, 2025

Uh oh!

hetangmodi-crest commented Apr 1, 2025

Uh oh!

hetangmodi-crest commented Apr 1, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

feat: add custom search command support #1653

feat: add custom search command support #1653

Uh oh!

Conversation

hetangmodi-crest commented Mar 21, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

PR Type

Summary

Changes

User experience

Checklist

Review

Tests

Uh oh!

kkedziak-splunk commented Mar 26, 2025

Uh oh!

hetangmodi-crest commented Mar 28, 2025

Uh oh!

hetangmodi-crest commented Apr 1, 2025

Uh oh!

hetangmodi-crest commented Apr 1, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

hetangmodi-crest commented Mar 21, 2025 •

edited

Loading