Config Ignore

Introduction

Ever experienced that your site's configuration was overridden, by the configuration on the file system, when running a drush cim?

Not anymore!

This module is a tool to let you keep the configuration you want, in place.

This module effectively lets you treat configuration as if it was content. It does so by changing the configuration that is about to be imported to the one that exists already on the site and therefore there is no difference that the configuration import would need to update.

Requirements

This module requires only Drupal core. With the advent of the Drupal 9 EOL soon this module will also require PHP 8.1+. However, 8.x-3.1 still works on Drupal 9 and its supported PHP versions.

Installation

There is nothing special about the installation of this module. Check the documentation for installing modules

Configuration

If you go to admin/config/development/configuration/ignore you will see a fairly simple interface.

Add the name of the configuration that you want to ignore. E.g. system.site to ignore site name, slogan and email site email address. Click the "Save configuration" button and you are good to go.

Do not ignore the core.extension configuration as it will prevent you from enabling new modules with a config import. Use the Config Split module for environment specific modules.

By selecting intermediate or advanced you get two or six text areas to fill respectively. This allows you to fine tune the configuration to ignore in different circumstances.

If you need to bypass Config Ignore you can update/create a single configuration by using the "Single import" feature at admin/config/development/configuration/single/import.

if you need to deactivate Config Ignore, include $settings['config_ignore_deactivate'] = TRUE; in your settings.php file.

Upgrade from version 2.x to 3.x

Be sure to run the update hooks so that the new mode configuration is set.
Config Ignore 2.x only ignored config on import (unless patched) whereas Config Ignore 3. ignores on import and on export in the simple mode. You can configure different configuration to ignore on import and export with the intermediate mode.
Attention: 2.x depended on Config Filter, but 3.x uses the core API. If you have not explicitly required Config Filter before Composer will remove it when updating. But then you are left with a drupal module still being installed but no longer available in the code base.
In order to properly uninstall Config Filter you should explicitly require it and then uninstall it, and remove it from composer.json only in a later deployment.

Maintainers

Current maintainers:

• Tommy Lynge Jørgensen (TLyngeJ) - https://www.drupal.org/u/tlyngej
• Fabian Bircher (bircher) - https://www.drupal.org/u/bircher
• Jordan Thompson (nord102) - https://www.drupal.org/u/nord102