Skip to main content

Cross-repo invariant verifier for the zyplux organization

Project description

cerberus

Verifies repository invariants — CI workflow structure, justfile and dependency conventions, CODEOWNERS, and release-version bumps — as a per-repo linter against a checkout.

Requirements

  • uv and Python 3.14

The justfile check shells out to just, which ships with the package (via rust-just) — no separate install.

Lint a repo

uv run cerberus            # lint the current directory
uv run cerberus PATH       # lint a checkout at PATH

Runs every check and exits non-zero on any failure or error, so it drops into CI like any linter. Run cerberus list to see every check, its scope, and what it verifies.

Option Description
--check NAME Limit to named check(s); repeatable
--config PATH Use a cerberus.toml other than the bundled
--fix Auto-fix fixable problems (e.g. trailing whitespace)

A repo opts out of specific checks with [tool.cerberus] disable = ["check-id", ...] in its pyproject.toml.

Checks

ID Scope Verifies
justfile content Recipe names, aliases, check pipeline, wrapped tool calls, no trailing whitespace
ci-workflow content ci.yml exists, exposes a ci check, runs on PRs (push to main recommended)
ci-sequence content ci.yml runs the canonical check sequence per stack, in the org container
cerberus-step content A CI workflow runs cerberus to self-verify org invariants
workflow-tooling content Workflows set up only the workspace toolchain (uv, bun), not extra tools
pyrefly-config content All code, tests included, type-checks under strict pyrefly with no relaxations
ruff-config content ruff runs standalone in preview with select = ["ALL"]; relaxations stay sanctioned
line-length content ruff line-length and prettier printWidth are both 120
rumdl-config content .rumdl.toml carries the org-canonical rule config (per-repo exclude allowed)
vitest-runner content TypeScript tests run on vitest, never bun's built-in test runner
ts-project-references content TypeScript typecheck runs via project references (tsc -b), not a per-package fan-out
catalog-discipline content Every workspace package.json dependency pins via catalog: or workspace:
story-tests-py content tests/**/stories/*.md criteria have a matching, title-matched pytest test
story-tests-ts content tests/**/stories/*.md criteria have a matching, title-matched vitest test
cli-ts-tests content CLI apps export only the root seam; story tests reach workspace code via fixture aliases
lib-ts-tests content Libraries export only the root seam; story tests reach workspace code via fixture aliases
release-bumps git-history A published target's version is bumped whenever its release surface changes
codeowners content CODEOWNERS present and covers /.github/
pytest-coverage content pyproject.toml [tool.coverage.report] fail_under is set to at least 90%
vitest-coverage content The root vitest.config.* coverage.thresholds are all set to at least 90%

Config

Policy — required recipes and aliases, the canonical CI sequence — lives in cerberus.toml. Override it with --config PATH.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

zyplux_cerberus-0.6.0.tar.gz (26.3 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

zyplux_cerberus-0.6.0-py3-none-any.whl (43.2 kB view details)

Uploaded Python 3

File details

Details for the file zyplux_cerberus-0.6.0.tar.gz.

File metadata

  • Download URL: zyplux_cerberus-0.6.0.tar.gz
  • Upload date:
  • Size: 26.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: uv/0.11.26 {"installer":{"name":"uv","version":"0.11.26","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

File hashes

Hashes for zyplux_cerberus-0.6.0.tar.gz
Algorithm Hash digest
SHA256 306a355038838926c813695a077730dff47897ecb1fd46b2cfddb0906efa4ae0
MD5 2015d31eb30e5af272c76e49ccb225c9
BLAKE2b-256 dd93bc556f64a86ee5d4f6a96fef851112af3ffc82ddd363ac22d46daeabf5a6

See more details on using hashes here.

File details

Details for the file zyplux_cerberus-0.6.0-py3-none-any.whl.

File metadata

  • Download URL: zyplux_cerberus-0.6.0-py3-none-any.whl
  • Upload date:
  • Size: 43.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: uv/0.11.26 {"installer":{"name":"uv","version":"0.11.26","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

File hashes

Hashes for zyplux_cerberus-0.6.0-py3-none-any.whl
Algorithm Hash digest
SHA256 17bcb9617f6d08b0855d3489bcb05a2568502bce3d1fc471d7c4bd3232c395bc
MD5 435a585f4265837a0cc319c36bf4d06d
BLAKE2b-256 78c52dbd9fbb32bed7487c62fd5d815f85e67cdce4a2c55d42d552a7aa5ef961

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page