Repository navigation
refactor: rename conformity to compliance - #555
Merged
Merged
Conversation
The command is now kates compliance; kates conformity stays as an alias so scripts keep working. The Go package, client types, Java package and classes, book chapter and appendix, anchors, chart comments, CI workflow step, live-test env var and plans all use compliance. The wire format keeps the old word: apiVersion conformity.kates.io/v1alpha1, the /api/conformity endpoints and the report kind ConformityReport. So does cli/examples/conformity, whose schema URL existing references point editors at. The CLI reference says so.
Comment-only edits to charts/kates and charts/kates-platform failed Chart versions: a changed chart needs a new version to be published. Two version bumps to republish comments are not worth it; the chart READMEs, which the check ignores, keep the new word.
bmscomp
added a commit
that referenced
this pull request
Oct 30, 2026
Image and kates-tester pins move to 1.33.0: kates 0.15.2, strimzi-operator 0.4.10, kafka-cluster 1.0.24, connect-cluster 2.1.19, mirror-maker2 0.11.17, kates-chaos 2.3.10, and kates-platform 0.8.15, which packs the four subcharts as they are on disk. Also kates/k8s, the Litmus experiment pins, the registry pages, the runbook, Recipe 7, server.json, the version matrix and the README's action pin. The backend image carries #529 (NO_PROXY *.domain wildcards), #537 (zones from broker racks), #545-#549 and #552-#553 (report, resilience, schedule and webhook fixes) and #555 (conformity renamed compliance). kates-tester is unchanged since 1.30.1.
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.
Why
The reference-architecture check is called compliance from now on. The command, code, file names and documentation say so; the wire format does not change, so existing reference files and older servers keep working.
What changes
kates compliance check|lint|fmt.kates conformitystays as a cobra alias; root help lists onlycompliance. JUnit suites are namedcompliance.<section>, and the command-profile key iscompliance.cli/internal/conformity→cli/internal/compliance;client.Conformity*→client.Compliance*;cli/cmd/conformity*.go→compliance*.go.com.bmscomp.kates.conformity→com.bmscomp.kates.compliance(ComplianceCheck,ComplianceReport,ComplianceResource, tests, native reflection list). OpenAPI tag "Compliance".compliance.mdandappendix-compliance-language.md, anchors renamed (gl-compliance-check,fig-compliance-*, …),_quarto.ymland the metrics baseline updated. The CLI reference gains one paragraph on the alias and the unchanged wire format.KATES_CONFORMITY_LIVE→KATES_COMPLIANCE_LIVEand the integration step that sets it;plans/compliance-*.md.Deliberately not changed
apiVersion: conformity.kates.io/v1alpha1,POST /api/conformity/check,/api/conformity/snapshot, and the report'skind: ConformityReport.cli/examples/conformity/: itskafkareference.v1alpha1.schema.jsonis referenced by URL from users' files; only the text inside the examples changed.Chart.yaml,values.yaml, templates) keep "conformity" in their comments: changing them would need a version bump for both charts, just to republish comments.Note:
kates compliance(reference check) now sits besidekates security compliance(CIS/SOC2/PCI).Tests
Run locally:
cli:go test ./...,go vet,golangci-lint run --new-from-rev=origin/main ./...(0 issues),scripts/check-cli-style.sh,scripts/check-cli-compat.sh,TestMCPCaveat*.kates:./mvnw test -Dquarkus.grpc.codegen.skip=true -Dquarkus.http.test-port=0— 1,768 tests, 0 failures;spotless:check.check-book-style.sh,gen-version-matrix.sh --check,gen-chart-table.sh --check,check-book-contrast.py,check-mermaid.sh,check-versions.sh,lychee --offline --include-fragments 'docs/**/*.md'(0 errors), scratch-copy HTML render +check-book-fragments.py(8,136 fragment links OK).CI only:
*ITtests, native image, Kind integration (runs the renamedComplianceLiveTest/ComplianceNamespacedLiveTest), Docker builds, CodeQL/Trivy.