Deprecate REQUIREMENT_INFO in favor of REQUIREMENT_OK

Created on 16 January 2025, 3 months ago

Problem/Motivation

Discovered while working on API docs for πŸ“Œ Create hook_runtime_requirements Active and πŸ“Œ Create class to replace hook_update_requirements Active . @nicxvan and I were trying to confirm the severity defaults for the various phases. For both update and runtime, if you return a requirements array without the severity key, it's treated as REQUIREMENT_OK.

However, for the update phase, REQUIREMENT_OK and REQUIREMENT_INFO are completely ignored. Only WARNING or ERROR matter.

Furthermore, for runtime, there's almost no difference in behavior between OK vs. INFO. The only functional change I could spot is that in the upper right of the status report, with the big green checkmark, there's a "N checked" text. That count (N) is only the OK requirements. An INFO requirement is displayed in the same table, but it doesn't get counted as "checked".

So on a local test site, I've got "26 checked", which is an anchor link down to the "Checked" area of the status report, where I've got 34 entries. Ugh.

Steps to reproduce

Proposed resolution

There seems to be no valid difference between INFO and OK for runtime requirements. Can we deprecate REQUIREMENT_INFO, treat it as REQUIREMENT_OK, and then everything should be counted on the status report and we can simply various docs.

Remaining tasks

User interface changes

Introduced terminology

API changes

Data model changes

Release notes snippet

πŸ“Œ Task
Status

Active

Version

11.0 πŸ”₯

Component

base system

Created by

πŸ‡ΊπŸ‡ΈUnited States dww

Live updates comments and jobs are added and updated live.
Sign in to follow issues

Comments & Activities

  • Issue created by @dww
  • πŸ‡ΊπŸ‡ΈUnited States dww

    Upon further investigation, OK and INFO sort of matter in the update case, but even that's perhaps another UI problem to solve. See summary for details.

Production build 0.71.5 2024