Problem/Motivation
The config_distro_filter module was initially created to provide filtering capabilities during configuration imports. However, with the introduction of a new API for managing configuration, modeled after the CMI 2.0 config transformation API, the config_distro_filter module has become redundant.
This new API enhances the developer experience and provides a more robust solution than the config_filter approach, eliminating the need for custom solutions like config_distro_filter. The details of this new API and its advantages are explained in the issue
New API for config_distro modeled after the new CMI2 config transformation API →
.
Proposed Resolution
We propose to deprecate the config_distro_filter module by:
1. Adding the lifecycle: deprecated key to the module's .info.yml file.
2. Including a lifecycle_link key that points to this issue summary, where the reason for deprecation is detailed.
3. Updating relevant documentation to reflect the deprecation.
Reason for Deprecation
The config_distro_filter module is deprecated because its functionality has been superseded by the new configuration management API introduced in Drupal core as part of CMI 2.0. This new API provides a more standardized, efficient, and integrated way to manage configuration transformations, eliminating the need for custom solutions like config_distro_filter.
For a detailed explanation of the new API and how it replaces the need for config_distro_filter, refer to
issue #3080778 →
.
Guidance for Site Owners
If your site is currently using the config_distro_filter submodule, follow these steps:
1. Determine if your site has anything in it that depends on the config_distro_filter module.
2. Uninstall the Submodule: It is safe to uninstall the config_distro_filter submodule after verifying that your site doesn't have a dependency on the config_distro_filter module.
3. Prepare for Removal: Note that the config_distro_filter submodule will be removed from the config_distro module in a future release, so plan accordingly.
Remaining Tasks
1. Deprecate the config_distro_filter module by updating its .info.yml file.
2. Add a lifecycle_link to this issue summary.
3. Remove or update any references to config_distro_filter in the documentation.
User Interface Changes
No user interface changes are required.
API Changes
No API changes are required.
Data Model Changes
No data model changes are required.