actions-marketplace-validations/Schema Registry CI/CD with ksr-cli

Automate Schema Registry operations in your CI/CD pipeline using the comprehensive ksr-cli tool

View on GitHub

Trust Signals

Scorecard Score
not yet scored
Maintenance Recency
Maintainedlast commit Dec 15, 2025
License
MIT

Pinned Snippet

workflow.ymlSHA-pinned
uses: actions-marketplace-validations/aywengo_schema-registry-action@ed482aa1e484e1e08ca0240ef9433d7b3addbe62 # no releases — HEAD as of 2026-07-10

tags can be moved; commit SHAs can't. why a SHA?

namedescriptionrequireddefault
operationOperation to perform (validate, check-compatibility, deploy, compare, export, lint, generate-docs)yes
registry-urlSchema Registry URLno
registry-typeType of registry - ksr-cli supports all Confluent-compatible registriesnoconfluent
schemas-pathPath to schema filesno./schemas
schema-fileSingle schema file pathno
subjectSchema subject nameno
subject-prefixPrefix to add to all subjectsno""
compatibility-levelCompatibility level (BACKWARD, FORWARD, FULL, NONE)noBACKWARD
schema-typeSchema type (avro, protobuf, json)noavro
output-formatOutput format (json, table, markdown)nojson
output-pathOutput path for exportsno
fail-on-errorFail the action on any errornotrue
dry-runPerform a dry run without making changesnofalse
create-subjectsCreate subjects if they do not existnotrue
normalize-schemasNormalize schemas before deploymentnotrue
include-versionsInclude versions (all, latest)nolatest
rules-filePath to linting rules fileno
source-registrySource registry URL for comparisonno
target-registryTarget registry URL for comparisonno
auth-methodAuthentication method (basic, api-key, oauth)nobasic
usernameRegistry usernameno
passwordRegistry passwordno
api-keyAPI key for authenticationno
api-secretAPI secret for authenticationno
tokenOAuth tokenno
debugEnable debug loggingnofalse
verboseEnable verbose outputnofalse
cli-versionksr-cli version to use (e.g., v0.2.3, latest)nov0.2.3
namedescription
validation-resultResult of schema validation
compatibility-resultResult of compatibility check
deployed-schemasList of deployed schemas
schema-diffDifferences between schemas
export-pathPath to exported schemas
operation-statusStatus of the operation (success/failure)
error-messageError message if operation failed