bc check

Engineering Community

Skill notes

Who gets hurt by a BC break in this repo

Keep these three user segments in mind. The severity of a finding depends on which segment it affects.

1. Developers running qlty locally

Individual developers download a qlty CLI version and often don't run qlty upgrade regularly, so their local version can be months behind main. They mostly invoke qlty check and qlty fmt against a .qlty/qlty.toml that's checked into their repo. A BC break here causes friction for one developer at a time — annoying but recoverable. Severity baseline: risky

2. Customers running qlty in their CI

Customers run qlty coverage publish and qlty coverage complete inside their CI pipelines on every build. Pipelines are hard to change in a hurry: a BC break here fails every build for every customer on the affected version, often silently (they don't notice until coverage stops showing up, or a release is blocked by red CI). This is the highest-stakes category.

3. Qlty Cloud's hosted builds

Qlty Cloud runs builds on behalf of customers and invokes the qlty CLI directly. The commands currently relied on include qlty sources fetch, qlty config validate, qlty fmt --skip-source-fetch, qlty init, qlty install, and qlty build. A BC break that affects any of these commands, or the config/source formats they depend on, causes a Qlty

Step 1 — Load the diff

Resolve the target from the user input: PR number / PR URL → gh pr view <N> --json title,body,headRefName,baseRefName,author,files and gh pr diff <N>. Branch name → git fetch origin main && git diff origin/main...<branch> and git log origin/main..<branch> --oneline. No input → current branch: git fetch origin main && git diff origin/main...HEAD and git log origin/main..HEAD --oneline. Read the PR description and commit messages first. Intent matters: a PR

Fluxly profile Runtime and permissions are inferred by Fluxly static checks, not author declarations or runtime test results.
Domain
Engineering
Author-declared agents
No explicit declaration found; this is not inferred or tested compatibility
Static check
94 / 100 · heuristic scan, not runtime safety proof
Runtime evidence
Not run; no isolated runtime test evidence is currently recorded
Author / version / license
@qltysh · NOASSERTION
Token usage
Moderate
Setup complexity
Plug-and-play
External API key
Not required
Operating systems
Unspecified (assume cross-platform)
Runtime requirements
No explicit requirements detected
Detected file/system behavior
  • Read-only
  • Write / modify
  • Env read
Network behavior
External requests
Install commands
None (reference only)

Heads up: Tool permissions are not declared; actual access depends on the runtime.

Output preview bc-check.preview
# d. Output formats

`qlty-coverage/src/print.rs`, any `print_*_as_json`, `serde_json::to_*`, `Serialize` derives on output types. Field renames/removals, numeric format changes, wire format changes in `qlty-types` protos. Also text output that scripts parse (CI log patterns, summary lines).

Discussion

Powered by GitHub Discussions. Sign in with GitHub to comment, react, or subscribe.