Breaking Change Risk
Detects removed public APIs and changed public method signatures that may break callers.
Why this rule exists
Public APIs are contracts with every caller in every consuming repo. Removing or renaming one without a deprecation cycle breaks downstream builds and forces emergency releases.
Code example
- public Task<Order> GetOrder(int id)
+ public Task<Order> GetOrderAsync(Guid id) [Obsolete("Use GetOrderAsync(Guid). Will be removed in v3.")]
public Task<Order> GetOrder(int id) => GetOrderAsync(new Guid(id.ToString()));
+ public Task<Order> GetOrderAsync(Guid id) { ... }Configuration
Disable or adjust the severity of this rule in .gauntletci.json:
{
"rules": {
"GCI0004": { "enabled": true, "severity": "Block" }
}
}See Configuration for the full schema.
Related rules
Data and Schema Compatibility
Detects removed serialization attributes and enum member removals that may break wire formats or persisted data.
Naming and Contract Alignment
Detects method renames where the new CRUD verb semantically contradicts the old verb, signaling an intent mismatch.
Dependency Bot API Drift
Fires when a dependency bot PR (Dependabot, Renovate, Snyk) contains both a lockfile change and a public API method signature change in C# files.
Discussed in
Detect Breaking Changes Before Merge
How to catch removed public APIs, signature changes, and serialization breaks at commit time instead of in downstream consumers.
What Is Diff-Based Analysis?
Diff-based analysis evaluates only what changed in a commit. Why that scope is the right unit of risk for pre-commit checks.
Real-world evidence
Implemented in src/GauntletCI.Core/Rules/Implementations/GCI0004_*.cs.
Eric Cogen -- Founder, GauntletCI
Twenty years in .NET production. Most of those years, the bugs that hurt me were not the ones tests caught. They were the assumptions I did not know I was making: a removed guard clause, a renamed method that still did the old thing, a catch {} that turned a page into a silent dashboard lie. GauntletCI is the checklist I wish I had run before every commit. It runs the rules I learned the hard way, so you do not have to.
