Skip to content

Propose what the version number promises - #21

Merged
tauanbinato merged 1 commit into
mainfrom
stability-policy
Sep 26, 2026
Merged

tauanbinato merged 1 commit into
mainfrom
stability-policy

Conversation

@tauanbinato

Copy link
Copy Markdown
Contributor

Left open for review: a policy draft; it commits the project to promises only you can make.

What and why

Phase 5 of the roadmap: a 1.0 stability policy, as a site page (site/src/stability.md, under Background).

  • Before 1.0: minor releases may change interfaces; patch releases only fix; pin a version in CI.
  • From 1.0, semver covers: commands and flags, exit codes, jevgate.toml keys, levels and rule names, the JSON report (additive fields; schema_version for removals and meaning changes), jevgate-baseline.json and fingerprints (an upgrade must not make accepted findings new), and SARIF, GitLab and annotation output.
  • Not covered: which findings rules report and their wording and probabilities (rule version bumps re-ask cached answers), the agent text, request bodies and the cache, and the default model.
  • Deprecation: at least one minor release with a stderr warning before a major release removes a flag or key.
  • Releases: batched minors, patches without waiting; binaries, crate, action, formula and site from the same tag.

Questions for review

  • Is the fingerprint promise right? It rules out changes that re-fingerprint findings without carrying the baseline over.
  • Should the MCP tools (Serve JevGate to coding agents over MCP #18) be covered once merged?
  • What must be true to call it 1.0 (for example, the README and site in their final shape, inline suppressions decided)?

A site page on versions and stability: what semver covers from 1.0 (commands, flags, exit codes, configuration, the JSON report, the baseline and fingerprints, SARIF and GitLab output), what it leaves to each release (findings, agent text, cache, default model), deprecations and batched releases.
@tauanbinato
tauanbinato merged commit f1f05e9 into main Sep 26, 2026
9 checks passed
@tauanbinato
tauanbinato deleted the stability-policy branch September 26, 2026 02:14
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant