[Feature request] Script to update zap files to match GUI output / policy to run script on zap update

[cecille]

Currently, the matter repo stores a number of .zap files for example code. Right now, when we update zap in the matter repo, these files are not updated. The result is that the zap files are out of date with what would be produced by the GUI in the tree. Right now, opening a matter .zap file in the GUI and saving the file with no changes results in a file diff. It is difficult for matter developers to understand if these diffs are correct and expected, especially since many of the changes are zap internal (moving sections, re-numbering). It also makes it easier for zap bugs to affect the matter codebase if they ride along with unrelated zap changes.

request:

• ensure the GUI output ordering and indexing are fixed for the same input file (ie, re-saving a file doesn't cause changes to the .zap)
• fix the zap_convert_all script to match the GUI output (perhaps with some kind of CI validation)
• have a policy that the script needs to be run when bumping the zap version in the sdk repo
• (maybe?) CI step to check that the zap files match the zap_convert_all output on all PRs so we can catch hand-editing etc.