Description
Summary
xsd validation fails on etc/adminhtml/system.xml files that contain <comments> below <field> items.
Examples
Launch PHPStorm and setup xsd validation, as per Magento devdocs.
Browse to a file containing a <comment> as a child to a <field>. Theres plenty to choose from
Check out the definition in the xsd file vendor/magento/module-config/etc/system_file.xsd
Notice that comment is not defined as a string.
Verify that on Experience League (https://experienceleague.adobe.com/en/docs/commerce-operations/configuration-guide/files/config-reference-systemxml), using <comment> as a child of <field> is supported. It is used extensively throughout Magento backend.
Proposed solution
Its an annoyance. Its been around for years. Its time to fix it.
Update type of comment to be string.
Release note
XSD validation now accepts <comment> entries as children of <field> entries in system.xml config files.
Triage and priority
- Severity: S0 - Affects critical data or functionality and leaves users without workaround.Severity: S1 - Affects critical data or functionality and forces users to employ a workaround.Severity: S2 - Affects non-critical data or functionality and forces users to employ a workaround.Severity: S3 - Affects non-critical data or functionality and does not force users to employ a workaround.Severity: S4 - Affects aesthetics, professional look and feel, “quality” or “usability”.
Metadata
Metadata
Assignees
Labels
Type
Projects
Milestone
Relationships
Development
Participants
Activity
m2-assistant commentedon Sep 9, 2024
Hi @gwharton. Thank you for your report.
To speed up processing of this issue, make sure that the issue is reproducible on the vanilla Magento instance following Steps to reproduce. To deploy vanilla Magento instance on our environment, Add a comment to the issue:
@magento give me 2.4-develop instance- upcoming 2.4.x release@magento I am working on thisJoin Magento Community Engineering Slack and ask your questions in #github channel.
⚠️ According to the Magento Contribution requirements, all issues must go through the Community Contributions Triage process. Community Contributions Triage is a public meeting.
🕙 You can find the schedule on the Magento Community Calendar page.
📞 The triage of issues happens in the queue order. If you want to speed up the delivery of your contribution, join the Community Contributions Triage session to discuss the appropriate ticket.
m2-assistant commentedon Sep 10, 2024
Hi @engcom-Hotel. Thank you for working on this issue.
In order to make sure that issue has enough information and ready for development, please read and check the following instruction: 👇
Area: XXXXXlabel to the ticket, indicating the functional areas it may be related to.2.4-developbranchDetails
- Add the comment@magento give me 2.4-develop instanceto deploy test instance on Magento infrastructure.- If the issue is reproducible on
2.4-developbranch, please, add the labelReproduced on 2.4.x.- If the issue is not reproducible, add your comment that issue is not reproducible and close the issue and stop verification process here!
Issue: Confirmedonce verification is complete.engcom-Hotel commentedon Sep 10, 2024
Hello @gwharton,
Thanks for the report and collaboration!
We are able to reproduce the issue in the latest 2.4-develop branch. Hence confirming the issue.
Thanks
14 remaining items