breaking change

A change that makes existing users of a program or interface stop working until they change something too.

In more detail

Removing or renaming something users rely on, changing its behaviour, or making an optional field required are all breaking. Under semantic versioning a breaking change requires a new major version, and it should be marked clearly in commit messages and release notes.

Examples

Renaming a component prop such as isOutline is a breaking change; design systems deprecate first and ship a codemod.
BREAKING CHANGE: clients must send Authorization on refresh.
feat(auth)!: require a token on every session endpoint
A Kafka consumer reading v["id"] breaks when producers rename id.
In Terraform: Under semantic versioning a breaking change needs a new major version and a migration note explaining what callers must change. Changing a module's internals while keeping its interface is not breaking, though renamed resources may need a moved block to avoid replacement.
In this course: Contract tests catch accidental breaking changes. When one is intentional, version the contract and migrate consumers deliberately.

Related terms

Taught in

References