aywengo/Schema Registry CI/CD with ksr-cli
Automate Schema Registry operations in your CI/CD pipeline using the comprehensive ksr-cli tool
View on GitHubTrust Signals
- Scorecard Score
- not yet scored
- Maintenance Recency
- Maintainedlast commit Dec 15, 2025
- License
- MIT
Pinned Snippet
uses: aywengo/schema-registry-action@b196ce499beadb2cc957c1ca02c47109ec69e5a4 # v1tags can be moved; commit SHAs can't. why a SHA?
Inputs
| name | description | required | default |
|---|---|---|---|
| operation | Operation to perform (validate, check-compatibility, deploy, compare, export, lint, generate-docs) | yes | — |
| registry-url | Schema Registry URL | no | — |
| registry-type | Type of registry - ksr-cli supports all Confluent-compatible registries | no | confluent |
| schemas-path | Path to schema files | no | ./schemas |
| schema-file | Single schema file path | no | — |
| subject | Schema subject name | no | — |
| subject-prefix | Prefix to add to all subjects | no | "" |
| compatibility-level | Compatibility level (BACKWARD, FORWARD, FULL, NONE) | no | BACKWARD |
| schema-type | Schema type (avro, protobuf, json) | no | avro |
| output-format | Output format (json, table, markdown) | no | json |
| output-path | Output path for exports | no | — |
| fail-on-error | Fail the action on any error | no | true |
| dry-run | Perform a dry run without making changes | no | false |
| create-subjects | Create subjects if they do not exist | no | true |
| normalize-schemas | Normalize schemas before deployment | no | true |
| include-versions | Include versions (all, latest) | no | latest |
| rules-file | Path to linting rules file | no | — |
| source-registry | Source registry URL for comparison | no | — |
| target-registry | Target registry URL for comparison | no | — |
| auth-method | Authentication method (basic, api-key, oauth) | no | basic |
| username | Registry username | no | — |
| password | Registry password | no | — |
| api-key | API key for authentication | no | — |
| api-secret | API secret for authentication | no | — |
| token | OAuth token | no | — |
| debug | Enable debug logging | no | false |
| verbose | Enable verbose output | no | false |
| cli-version | ksr-cli version to use (e.g., v0.2.3, latest) | no | v0.2.3 |
Outputs
| name | description |
|---|---|
| validation-result | Result of schema validation |
| compatibility-result | Result of compatibility check |
| deployed-schemas | List of deployed schemas |
| schema-diff | Differences between schemas |
| export-path | Path to exported schemas |
| operation-status | Status of the operation (success/failure) |
| error-message | Error message if operation failed |