feat(constructs): add structured check intent [ship] - #1428
Merged
Conversation
thebiglabasky
marked this pull request as ready for review
August 4, 2026 17:55
thebiglabasky
enabled auto-merge (squash)
August 14, 2026 15:02
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.
Summary
CheckIntentauthoring as a goal plus typed constraints on the RCA/self-healing check typesnullexplicitly clears itconstraintsarray directly to project deploysrequiredOutcomes/mustPreserveConstruct shape
constraintsis optional for concise goal-only authoring. The currently supported constraint types areREQUIRED_OUTCOMEandMUST_PRESERVE; new kinds can extend the discriminant without changing the enclosing intent shape.Supported constructs
ApiCheck,BrowserCheck,MultiStepCheck,PlaywrightCheck,UrlMonitor,DnsMonitor,IcmpMonitor,TcpMonitor, andGrpcMonitoraccept intent.AgenticCheck,HeartbeatMonitor,SslMonitor, andTracerouteMonitorintentionally do not expose it. Their code generators also ignore unexpected backend intent so imports keep producing valid construct code.Deployment semantics
intent: undefinedomits the field from the synthesized resource and preserves UI/API-authored intentgoalplus typedconstraintsconstraintssynthesizesconstraints: []intent: nullsynthesizes an explicit clearBackend dependency and rollout
This CLI shape depends on checkly/monorepo#3661, which updates
/v1/projects/deployto accept typed constraints and returns the same shape from imports and/v3/checkswhile preserving/v1/checksand/v2/checks.Merge and deploy the backend PR before releasing this CLI PR. Older CLI versions remain compatible because they omit intent entirely. The codegen fallback for the stored array shape covers import plans persisted before the backend cutover.
Validation
pnpm lintpnpm --filter checkly run prepare:distpnpm --filter checkly run test:typespnpm pack