All rules

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

Triggers the rule
- public Task<Order> GetOrder(int id)
+ public Task<Order> GetOrderAsync(Guid id)
Passes the rule
  [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

Discussed in

Real-world evidence

Implemented in src/GauntletCI.Core/Rules/Implementations/GCI0004_*.cs.

About the author

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.