Document the deprecation of simpleConfigUpdate on config entities, and new setProperties config action [#3515735]

Problem

It's unclear from documentation on how to use simpleConfigUpdate on config entities, or what to use.

Citing #3439713: Deprecate using the simpleConfigUpdate action on config entities, and introduce a new setProperties action to replace the invalid use cases:

\Drupal\Core\Config\Action\Plugin\ConfigAction\SimpleConfigUpdate::apply() can change config entities. It shouldn't be used for that, though, because it totally bypasses the entity API and the many important hooks in it.

Proposed resolution

Properly document the change.

Issue: https://www.drupal.org/project/drupal/issues/3439713
Change record: https://www.drupal.org/node/3515543

This has been merged is available since 11.2.

Issue fork distributions_recipes-3515735

Show commands

Start within a Git clone of the project using the version control instructions.

Add & fetch this issue fork’s repository

Or, if you do not have SSH keys set up on git.drupalcode.org:

Add & fetch this issue fork’s repository

fix-docs changes, plain diff MR !202
Check out this branch for the first time

Check out existing branch, if you already have it locally
3515735-document-the-deprecation compare
Check out this branch for the first time

Check out existing branch, if you already have it locally

About issue forks

Comments

Comment #1

27 March 2025 at 12:55

thejimbirch created an issue. See original summary.

Comment #2

thejimbirch commented 31 March 2025 at 23:02

Title:	[PP-1] Document the deprecation of simpleConfigUpdate on config entities, and new setProperties config action	» Document the deprecation of simpleConfigUpdate on config entities, and new setProperties config action
Issue summary:	View changes
Status:	Postponed	» Active