ci(options): Validate sentry-options schema changes on PRs - #669
Merged
Conversation
Add the sentry-options schema-validation workflow from the onboarding guide. It runs on PRs that touch sentry-options/schemas, catching both malformed schemas and illegal schema evolution — changing an option's type or default, and other backward-incompatible edits — before they reach the automator and break deployed readers. The test suite's init() only checks a schema is well-formed; it can't see the previous schema, so this closes the evolution-safety gap. The CLI version is parsed from uv.lock so validation runs the same sentry-options version the service pins.
![github-advanced-security[bot]](https://avatars.githubusercontent.com/in/57789?s=60&v=4){kind=small}
Add an explicit top-level `permissions: contents: read` so the workflow does not inherit the default broad GITHUB_TOKEN scope (flagged by CodeQL). Read access is all the checkout and the reusable validation workflow need.
kenzoengineer
approved these changes
Sep 3, 2026
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
3 participants
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.
Adds the sentry-options schema-validation workflow from the onboarding guide — the piece that was missing after the initial integration (#668).
It runs on PRs that touch
sentry-options/schemas/**(oruv.lock) and calls the reusablegetsentry/sentry-options/.github/workflows/validate-schema.ymlto check two things: that the schema is well-formed, and — the important part — that a change doesn't violate the schema-evolution rules, like changing an option's type or default or making another backward-incompatible edit. Those are the changes that would break already-deployed readers of an option, and the existing test suite can't catch them:init()only validates that a schema is well-formed, with no visibility into the previous version.Follows seer's two-job pattern: a first job parses the pinned
sentry-optionsversion out ofuv.lockso validation runs the exact same CLI version the service depends on (1.2.9 today), and the reusable workflow is SHA-pinned to the matching release. The workflow validates its own PR (no schema change here, so it passes cleanly), which confirms the wiring.