ci(schema): check for OpenAPI and GraphQL schema changes

[andrewazores]

Welcome to Cryostat3! 👋

Before contributing, make sure you have:

• Read the contributing guidelines
• Linked a relevant issue which this PR resolves
• Linked any other relevant issues, PR's, or documentation, if any
• Resolved all conflicts, if any
• Rebased your branch PR on top of the latest upstream main branch
• Attached at least one of the following labels to the PR: [chore, ci, docs, feat, fix, test]
• Signed all commits using a GPG signature

To recreate commits with GPG signature git fetch upstream && git rebase --force --gpg-sign upstream/main

---

Related to #333

Description of the change:

Checks in the OpenAPI definition to schemas/openapi.yaml, transformed with yq so that the keys are sorted and therefore can be compared across revisions without worrying about exact key ordering. The GraphQL schema is also checked in to schemas/schema.graphql, but this is commented out since it depends on #294 .

Then, adds a CI action on /build_test that runs on PR to regenerate the schema(s) within the CI runner and check if the PR schema differs from the main schema. A bot comment indicates change/no-change for each schema, including the diff if there is a change found.

Sample run: https://github.com/andrewazores/cryostat3/actions/runs/8361776180

The GraphQL schema change is expected, this patch was applied for testing: andrewazores#1

diff --git a/src/main/java/io/cryostat/graphql/ArchivedRecordings.java b/src/main/java/io/cryostat/graphql/ArchivedRecordings.java
index afcf36f..d6fcbbf 100644
--- a/src/main/java/io/cryostat/graphql/ArchivedRecordings.java
+++ b/src/main/java/io/cryostat/graphql/ArchivedRecordings.java
@@ -39,6 +39,11 @@ public class ArchivedRecordings {
 
     @Inject RecordingHelper recordingHelper;
 
+    @Query("hello")
+    public String hello() {
+        return "hello there";
+    }
+
     @Blocking
     @Query("archivedRecordings")
     public TargetNodes.ArchivedRecordings listArchivedRecordings(ArchivedRecordingsFilter filter) {

Motivation for the change:

This is meant to help developers and maintainers notice when they have made changes to the exposed interfaces, to help prevent inadvertent changes which may break compatibility, as well as to highlight intentional breakages or new features to help inform the next release's semantic versioning name.

[github-actions]

This PR/issue depends on:

• feat(graphql): reimplement GraphQL API #294
  By Dependent Issues (🤖). Happy coding!

[andrewazores]

/build_test

[github-actions]

Workflow started at 3/20/2024, 12:09:31 PM. View Actions Run.

[github-actions]

CI build and push: All tests pass ✅ (JDK21)
https://github.com/cryostatio/cryostat3/actions/runs/8362172946

[github-actions]

CI build and push: All tests pass ✅ (JDK17)
https://github.com/cryostatio/cryostat3/actions/runs/8362172946

[ebaron]

It seems like it's possible to do the sorting with an OpenAPI filter in Quarkus: quarkusio/quarkus#28509

That looks like more work than simply installing and using yq though.