Repository navigation
ci: check api compatibility and report coverage - #10
Merged
Merged
Conversation
Contributor
Test results 147 files 147 suites 1m 16s ⏱️ Results for commit 8e83811. ♻️ This comment has been updated with latest results. |
TheMeinerLP
force-pushed
the
ci/api-diff-and-coverage
branch
from
October 28, 2026 17:48
c55901c to
4a6f2ae
Compare
TheMeinerLP
force-pushed
the
ci/api-diff-and-coverage
branch
from
October 28, 2026 19:15
4a6f2ae to
8e83811
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Proposed changes
Three clients depend on Quelea's HTTP API: the Velocity plugin, the generated Java client and, soon, the lobby. Until now nothing told a reviewer that a pull request changed that API in a way existing clients cannot follow: a renamed field, a removed route, a new required parameter. Such a change only showed up once a proxy started failing.
Every pull request now builds the OpenAPI document for its base and its head and compares them with oasdiff. The job summary lists every API change, and a breaking one fails the check. The specs stay inside CI and are not uploaded anywhere.
We also had no view of how much of the code the tests reach. JaCoCo now writes coverage after every test run, and a coverage job publishes it to Codecov, the same way Ingot does. Coverage never fails a build.
Types of changes
Checklist
Further comments
The shared
gradle-build-prworkflow has no coverage inputs, so the coverage job runs the test suite once more on Linux. Codecov uploads work withoutCODECOV_TOKENbut are rate-limited; add the secret if the org has one. Checked other ways to catch API breaks (Pact, Schemathesis) and left them out for now: oasdiff needs no extra infrastructure and catches the common case.