Problem/Motivation

This module's configuration schema definition is missing.

Notably, if you try to install the module as part of an automated test, you get the following error:

Drupal\Core\Config\Schema\SchemaIncompleteException: No schema for config_profile.settings

Proposed resolution

Add a configuration schema, i.e.: to a config/schema/config_profile.schema.yml file.

Remaining tasks

  1. Write a patch
  2. Review and feedback
  3. RTBC and feedback
  4. Commit
  5. Release

User interface changes

None.

API changes

None.

Data model changes

None.

Documentation links

  1. Documentation -> Drupal -> Drupal APIs -> Configuration API -> Configuration schema/metadata
  2. Drupal core Change records -> Configuration schema for field settings, default values and entity view/form displays changed
CommentFileSizeAuthor
#5 interdiff--4-5.txt448 bytesmparker17
#5 3172300-5--add-config-schema.patch2.52 KBmparker17
#4 interdiff--2-4.txt1.3 KBmparker17
#4 3172300-4--add-config-schema.patch2.45 KBmparker17
#2 3172300-2--add-config-schema.patch1.02 KBmparker17

Comments

mparker17 created an issue. See original summary.

mparker17’s picture

mparker17
he/him
Primary language English
Location UTC-5
commented
Issue summary: View changes
StatusFileSize
new 3172300-2--add-config-schema.patch1.02 KB

Here's a patch. Reviews welcome.

mparker17’s picture

mparker17
he/him
Primary language English
Location UTC-5
commented
Status: Active » Needs review

I should probably mark this as "Needs Review" so someone reviews it 🙃

mparker17’s picture

mparker17
he/him
Primary language English
Location UTC-5
commented
StatusFileSize
new 3172300-4--add-config-schema.patch2.45 KB
new interdiff--2-4.txt1.3 KB

Here's a patch that adds a test to see if the module correctly installs... if it does, then (among other things) there are no config schema issues.

Note to the module maintainer: testbot will only run if you enable automated testing. To do this, go to this module's Automated Testing page, click Add test / retest under the branch you want to enable testing on (probably 8.x-1.x-dev), and follow the instructions (the default environment and core are probably fine, but for Schedule you probably want to set Run on commit and for issues)

mparker17’s picture

mparker17
he/him
Primary language English
Location UTC-5
commented
StatusFileSize
new 3172300-5--add-config-schema.patch2.52 KB
new interdiff--4-5.txt448 bytes

Added a $defaultTheme to the test.

mparker17’s picture

mparker17
he/him
Primary language English
Location UTC-5
commented
Issue summary: View changes

Added links to the documentation I was reading when I was trying to write the patch.

mparker17’s picture

mparker17
he/him
Primary language English
Location UTC-5
commented
Issue summary: View changes

akalam’s picture

akalam commented
Status: Needs review » Fixed

Looks good! thank you @mparker17, specially for the test!

mparker17’s picture

mparker17
he/him
Primary language English
Location UTC-5
commented

Awesome, thank you @akalam!

Could I trouble you to enable automated tests to run on commit and for issues on the 8.x-1.x-dev branch, i.e.: to (hopefully) catch future patches before they cause config schema regressions? (I included instructions at the bottom of #4)

mparker17’s picture

mparker17
he/him
Primary language English
Location UTC-5
commented

@akalam, I see automated tests are enabled, but are throwing a composer error... I've confirmed config_profile's composer.json is valid... I think the PHP/MySQL versions in the test environment are too low for Drupal 9... the test is 8.x-1.x-dev test with PHP 5.3 & MySQL 5.5, Drupal 9.1.x but Drupal 9 requires at least PHP 7.3, and at least MySQL 5.7. This is my fault, I said "the default environment and core are probably fine" but that's not true! Sorry for that!

I believe if you go back to the automated testing page, click the "edit" link, you can set the environment to "PHP 7.3 & MySQL 5.7"... and when you click "Save & queue" the composer errors will go away.

Status: Fixed » Closed (fixed)

Automatically closed - issue fixed for 2 weeks with no activity.