TEST: validate api-break-allowed escape hatch (do not merge)#4992
Closed
ChrisJBurns wants to merge 2 commits intomainfrom
Closed
TEST: validate api-break-allowed escape hatch (do not merge)#4992ChrisJBurns wants to merge 2 commits intomainfrom
ChrisJBurns wants to merge 2 commits intomainfrom
Conversation
Deliberate breaking change to validate the Phase 2 enforcement from #4991: 1. The CRD Schema Compatibility check fails the PR (no longer advisory). 2. Applying the api-break-allowed label + a re-trigger (push / reopen / manual re-run) causes the job to be skipped, which counts as passing for branch protection, unblocking the PR. The Go field name stays as Description to avoid cascading into 20+ test files; only the JSON tag moves from "description" to "summary", which propagates to the CRD schema via controller-gen. DO NOT MERGE. Close once enforcement + escape hatch have been demonstrated. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #4992 +/- ##
==========================================
- Coverage 69.03% 68.99% -0.05%
==========================================
Files 552 552
Lines 72996 72996
==========================================
- Hits 50395 50364 -31
- Misses 19601 19632 +31
Partials 3000 3000 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
10 tasks
Collaborator
Author
|
Closing — test served its purpose and uncovered a real gap. What we validated:
What we uncovered:
Follow-up opened: #4993 adds |
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.
Phase 2 enforcement validation. Pairs with #4988 (pre-enforcement) to close the loop: the same breaking change that previously only turned the check red should now block the PR, and applying
api-break-allowedshould unblock it.Close this PR once the escape hatch has been demonstrated.
What changed
Same surgical change as #4988: the JSON tag on
MCPGroupSpec.Descriptionis renamed from"description"to"summary". Go field name stays, only the schema-visible key moves.task operator-generate+task operator-manifestsregenerated the CRD YAML and Helm template.Test procedure
Observe enforcement kicks in.
CRD Schema Compatibilityruns, reports 2×NoFieldRemovalonmcpgroups(v1alpha1andv1beta1).failure.failure(unlike TEST: rename mcpgroups.spec.description → summary (do not merge) #4988, there's nocontinue-on-errorsoftening it).mergeStateStatus: BLOCKED— the PR cannot be merged.Apply the escape hatch.
api-break-allowedlabel to the PR.pull_requesttrigger uses default types (opened,synchronize,reopened) — label changes don't trigger a re-run on their own. After labelling, do one of:git commit --allow-empty -m trigger && git push).if:guard:!contains(labels.*.name, 'api-break-allowed')is now false, so thecrd-schema-checkjob is skipped.mergeStateStatusflips to an unblocked state.Close the PR without merging.
Expected signals
failurefailureBLOCKEDskippedskipped(or whatever the other jobs produce)CLEANor similarRecommended follow-up (not this PR)
Add
types: [opened, synchronize, reopened, labeled, unlabeled]to thepull_requesttrigger in.github/workflows/api-compat.yml. That would let the escape hatch work without the push/reopen/manual-rerun dance — applying the label alone would re-run the workflow and skip the job. Small, self-contained follow-up PR.Type of change
Test plan
task operator-generate/task operator-manifestsregenerated cleanlyv1alpha1andv1beta1CRD versions now exposespec.summaryinstead ofspec.descriptionapi-break-allowedand re-triggering, the job is skipped and the PR is no longer blocked by this checkAPI Compatibility
v1beta1API, OR theapi-break-allowedlabel is applied and the migration guidance is described above.(This is a test PR. The "break" is intentional and will be reverted by closing the PR without merging. The checkbox above is for contributor-facing PRs; this PR deliberately trips the check to validate enforcement.)
Does this introduce a user-facing change?
No. This PR will never be merged.
Generated with Claude Code