Consistency and Version Checks (consistency, check)
Treat these commands as your repository quality gate before builds and releases.
consistency
Checks worker structure and metadata consistency.
# all workers
npx worker-cli consistency
# specific workers
npx worker-cli consistency opc-reader json-normalizer
It validates:
- Worker folder conventions
- Required files (
src/,Dockerfile,README*.md) - Worker type detectability
- Version presence and semver shape warnings
- Optional
issues.yamlnotes/warnings/errors
check
Shows a compact table of worker type + detected version.
npx worker-cli check
Use this when preparing release batches.
Suggested policy
feature branch: consistency <target-worker>
before merge: consistency (all) + check
before release: consistency (all) + check + build --push
issues.yaml as controlled debt registry
You can attach operator notes to a worker in workers/<name>/issues.yaml.
notes:
- Requires plant VPN for on-site tests.
warnings:
- OPC endpoint retry interval is conservative by design.
errors:
- Missing failover endpoint for production profile.
[INFO!monitoring/INTENT]
issues.yamlhelps teams keep known constraints visible during CI and release reviews.
References
sdk/worker/repo-management/src/commands/consistency-check.tssdk/worker/repo-management/src/commands/version-check.ts