Show a diff of any changes to generated schemas

[wlach]

To prevent problems like https://bugzilla.mozilla.org/show_bug.cgi?id=1737656 from recurring, we should use a similar approach as mozilla-pipeline-schemas, and show what any changes to the schema as a result of a push might look like via a ci bot.

The rough procedure we want to automate is here:

https://github.com/mozilla/mozilla-schema-generator#development-and-testing

Off the top of my head, I can think of two alternatives for getting the schemas to compare against (perhaps @jklukas can think of others):

1. Compare against running the schema generation process against main (basically what the instructions say to do right now).
2. Compare against what's in mozilla-pipeline-schemas generated-schemas branch.

Prior Art

Example of MPS's CI bot in action:

mozilla-services/mozilla-pipeline-schemas#646 (comment)

The implementation, I believe, is defined here:

• https://github.com/mozilla-services/mozilla-pipeline-schemas/blob/main/.circleci/post-artifact.js
• https://github.com/mozilla-services/mozilla-pipeline-schemas/blob/cd026852f61f119d721f2029041e2fd3caacd667/.circleci/config.yml#L49

[acmiyaguchi]

Just a note that a validation diff exists via #156. The validation files get written to disk, and could be uploaded as artifacts during a PR.

[wlach]

Just a note that a validation diff exists via #156. The validation files get written to disk, and could be uploaded as artifacts during a PR.

Thanks @acmiyaguchi! Super helpful context, hope you're doing well.